aws.location.PlaceIndex
Explore with Pulumi AI
Provides a Location Service Place Index.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.location.PlaceIndex("example", {
dataSource: "Here",
indexName: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.location.PlaceIndex("example",
data_source="Here",
index_name="example")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/location"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := location.NewPlaceIndex(ctx, "example", &location.PlaceIndexArgs{
DataSource: pulumi.String("Here"),
IndexName: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Location.PlaceIndex("example", new()
{
DataSource = "Here",
IndexName = "example",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.location.PlaceIndex;
import com.pulumi.aws.location.PlaceIndexArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new PlaceIndex("example", PlaceIndexArgs.builder()
.dataSource("Here")
.indexName("example")
.build());
}
}
resources:
example:
type: aws:location:PlaceIndex
properties:
dataSource: Here
indexName: example
Create PlaceIndex Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PlaceIndex(name: string, args: PlaceIndexArgs, opts?: CustomResourceOptions);
@overload
def PlaceIndex(resource_name: str,
args: PlaceIndexArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PlaceIndex(resource_name: str,
opts: Optional[ResourceOptions] = None,
data_source: Optional[str] = None,
index_name: Optional[str] = None,
data_source_configuration: Optional[PlaceIndexDataSourceConfigurationArgs] = None,
description: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewPlaceIndex(ctx *Context, name string, args PlaceIndexArgs, opts ...ResourceOption) (*PlaceIndex, error)
public PlaceIndex(string name, PlaceIndexArgs args, CustomResourceOptions? opts = null)
public PlaceIndex(String name, PlaceIndexArgs args)
public PlaceIndex(String name, PlaceIndexArgs args, CustomResourceOptions options)
type: aws:location:PlaceIndex
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args PlaceIndexArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PlaceIndexArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PlaceIndexArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PlaceIndexArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PlaceIndexArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var placeIndexResource = new Aws.Location.PlaceIndex("placeIndexResource", new()
{
DataSource = "string",
IndexName = "string",
DataSourceConfiguration = new Aws.Location.Inputs.PlaceIndexDataSourceConfigurationArgs
{
IntendedUse = "string",
},
Description = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := location.NewPlaceIndex(ctx, "placeIndexResource", &location.PlaceIndexArgs{
DataSource: pulumi.String("string"),
IndexName: pulumi.String("string"),
DataSourceConfiguration: &location.PlaceIndexDataSourceConfigurationArgs{
IntendedUse: pulumi.String("string"),
},
Description: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var placeIndexResource = new PlaceIndex("placeIndexResource", PlaceIndexArgs.builder()
.dataSource("string")
.indexName("string")
.dataSourceConfiguration(PlaceIndexDataSourceConfigurationArgs.builder()
.intendedUse("string")
.build())
.description("string")
.tags(Map.of("string", "string"))
.build());
place_index_resource = aws.location.PlaceIndex("placeIndexResource",
data_source="string",
index_name="string",
data_source_configuration={
"intended_use": "string",
},
description="string",
tags={
"string": "string",
})
const placeIndexResource = new aws.location.PlaceIndex("placeIndexResource", {
dataSource: "string",
indexName: "string",
dataSourceConfiguration: {
intendedUse: "string",
},
description: "string",
tags: {
string: "string",
},
});
type: aws:location:PlaceIndex
properties:
dataSource: string
dataSourceConfiguration:
intendedUse: string
description: string
indexName: string
tags:
string: string
PlaceIndex Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PlaceIndex resource accepts the following input properties:
- Data
Source string - Specifies the geospatial data provider for the new place index.
- Index
Name string The name of the place index resource.
The following arguments are optional:
- Data
Source PlaceConfiguration Index Data Source Configuration - Configuration block with the data storage option chosen for requesting Places. Detailed below.
- Description string
- The optional description for the place index resource.
- Dictionary<string, string>
- Key-value tags for the place index. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- Data
Source string - Specifies the geospatial data provider for the new place index.
- Index
Name string The name of the place index resource.
The following arguments are optional:
- Data
Source PlaceConfiguration Index Data Source Configuration Args - Configuration block with the data storage option chosen for requesting Places. Detailed below.
- Description string
- The optional description for the place index resource.
- map[string]string
- Key-value tags for the place index. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- data
Source String - Specifies the geospatial data provider for the new place index.
- index
Name String The name of the place index resource.
The following arguments are optional:
- data
Source PlaceConfiguration Index Data Source Configuration - Configuration block with the data storage option chosen for requesting Places. Detailed below.
- description String
- The optional description for the place index resource.
- Map<String,String>
- Key-value tags for the place index. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- data
Source string - Specifies the geospatial data provider for the new place index.
- index
Name string The name of the place index resource.
The following arguments are optional:
- data
Source PlaceConfiguration Index Data Source Configuration - Configuration block with the data storage option chosen for requesting Places. Detailed below.
- description string
- The optional description for the place index resource.
- {[key: string]: string}
- Key-value tags for the place index. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- data_
source str - Specifies the geospatial data provider for the new place index.
- index_
name str The name of the place index resource.
The following arguments are optional:
- data_
source_ Placeconfiguration Index Data Source Configuration Args - Configuration block with the data storage option chosen for requesting Places. Detailed below.
- description str
- The optional description for the place index resource.
- Mapping[str, str]
- Key-value tags for the place index. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- data
Source String - Specifies the geospatial data provider for the new place index.
- index
Name String The name of the place index resource.
The following arguments are optional:
- data
Source Property MapConfiguration - Configuration block with the data storage option chosen for requesting Places. Detailed below.
- description String
- The optional description for the place index resource.
- Map<String>
- Key-value tags for the place index. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Outputs
All input properties are implicitly available as output properties. Additionally, the PlaceIndex resource produces the following output properties:
- Create
Time string - The timestamp for when the place index resource was created in ISO 8601 format.
- Id string
- The provider-assigned unique ID for this managed resource.
- Index
Arn string - The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Update
Time string - The timestamp for when the place index resource was last update in ISO 8601.
- Create
Time string - The timestamp for when the place index resource was created in ISO 8601 format.
- Id string
- The provider-assigned unique ID for this managed resource.
- Index
Arn string - The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Update
Time string - The timestamp for when the place index resource was last update in ISO 8601.
- create
Time String - The timestamp for when the place index resource was created in ISO 8601 format.
- id String
- The provider-assigned unique ID for this managed resource.
- index
Arn String - The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - update
Time String - The timestamp for when the place index resource was last update in ISO 8601.
- create
Time string - The timestamp for when the place index resource was created in ISO 8601 format.
- id string
- The provider-assigned unique ID for this managed resource.
- index
Arn string - The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - update
Time string - The timestamp for when the place index resource was last update in ISO 8601.
- create_
time str - The timestamp for when the place index resource was created in ISO 8601 format.
- id str
- The provider-assigned unique ID for this managed resource.
- index_
arn str - The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - update_
time str - The timestamp for when the place index resource was last update in ISO 8601.
- create
Time String - The timestamp for when the place index resource was created in ISO 8601 format.
- id String
- The provider-assigned unique ID for this managed resource.
- index
Arn String - The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - update
Time String - The timestamp for when the place index resource was last update in ISO 8601.
Look up Existing PlaceIndex Resource
Get an existing PlaceIndex resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PlaceIndexState, opts?: CustomResourceOptions): PlaceIndex
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
create_time: Optional[str] = None,
data_source: Optional[str] = None,
data_source_configuration: Optional[PlaceIndexDataSourceConfigurationArgs] = None,
description: Optional[str] = None,
index_arn: Optional[str] = None,
index_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
update_time: Optional[str] = None) -> PlaceIndex
func GetPlaceIndex(ctx *Context, name string, id IDInput, state *PlaceIndexState, opts ...ResourceOption) (*PlaceIndex, error)
public static PlaceIndex Get(string name, Input<string> id, PlaceIndexState? state, CustomResourceOptions? opts = null)
public static PlaceIndex get(String name, Output<String> id, PlaceIndexState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Create
Time string - The timestamp for when the place index resource was created in ISO 8601 format.
- Data
Source string - Specifies the geospatial data provider for the new place index.
- Data
Source PlaceConfiguration Index Data Source Configuration - Configuration block with the data storage option chosen for requesting Places. Detailed below.
- Description string
- The optional description for the place index resource.
- Index
Arn string - The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.
- Index
Name string The name of the place index resource.
The following arguments are optional:
- Dictionary<string, string>
- Key-value tags for the place index. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Update
Time string - The timestamp for when the place index resource was last update in ISO 8601.
- Create
Time string - The timestamp for when the place index resource was created in ISO 8601 format.
- Data
Source string - Specifies the geospatial data provider for the new place index.
- Data
Source PlaceConfiguration Index Data Source Configuration Args - Configuration block with the data storage option chosen for requesting Places. Detailed below.
- Description string
- The optional description for the place index resource.
- Index
Arn string - The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.
- Index
Name string The name of the place index resource.
The following arguments are optional:
- map[string]string
- Key-value tags for the place index. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Update
Time string - The timestamp for when the place index resource was last update in ISO 8601.
- create
Time String - The timestamp for when the place index resource was created in ISO 8601 format.
- data
Source String - Specifies the geospatial data provider for the new place index.
- data
Source PlaceConfiguration Index Data Source Configuration - Configuration block with the data storage option chosen for requesting Places. Detailed below.
- description String
- The optional description for the place index resource.
- index
Arn String - The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.
- index
Name String The name of the place index resource.
The following arguments are optional:
- Map<String,String>
- Key-value tags for the place index. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - update
Time String - The timestamp for when the place index resource was last update in ISO 8601.
- create
Time string - The timestamp for when the place index resource was created in ISO 8601 format.
- data
Source string - Specifies the geospatial data provider for the new place index.
- data
Source PlaceConfiguration Index Data Source Configuration - Configuration block with the data storage option chosen for requesting Places. Detailed below.
- description string
- The optional description for the place index resource.
- index
Arn string - The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.
- index
Name string The name of the place index resource.
The following arguments are optional:
- {[key: string]: string}
- Key-value tags for the place index. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - update
Time string - The timestamp for when the place index resource was last update in ISO 8601.
- create_
time str - The timestamp for when the place index resource was created in ISO 8601 format.
- data_
source str - Specifies the geospatial data provider for the new place index.
- data_
source_ Placeconfiguration Index Data Source Configuration Args - Configuration block with the data storage option chosen for requesting Places. Detailed below.
- description str
- The optional description for the place index resource.
- index_
arn str - The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.
- index_
name str The name of the place index resource.
The following arguments are optional:
- Mapping[str, str]
- Key-value tags for the place index. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - update_
time str - The timestamp for when the place index resource was last update in ISO 8601.
- create
Time String - The timestamp for when the place index resource was created in ISO 8601 format.
- data
Source String - Specifies the geospatial data provider for the new place index.
- data
Source Property MapConfiguration - Configuration block with the data storage option chosen for requesting Places. Detailed below.
- description String
- The optional description for the place index resource.
- index
Arn String - The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.
- index
Name String The name of the place index resource.
The following arguments are optional:
- Map<String>
- Key-value tags for the place index. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - update
Time String - The timestamp for when the place index resource was last update in ISO 8601.
Supporting Types
PlaceIndexDataSourceConfiguration, PlaceIndexDataSourceConfigurationArgs
- Intended
Use string - Specifies how the results of an operation will be stored by the caller. Valid values:
SingleUse
,Storage
. Default:SingleUse
.
- Intended
Use string - Specifies how the results of an operation will be stored by the caller. Valid values:
SingleUse
,Storage
. Default:SingleUse
.
- intended
Use String - Specifies how the results of an operation will be stored by the caller. Valid values:
SingleUse
,Storage
. Default:SingleUse
.
- intended
Use string - Specifies how the results of an operation will be stored by the caller. Valid values:
SingleUse
,Storage
. Default:SingleUse
.
- intended_
use str - Specifies how the results of an operation will be stored by the caller. Valid values:
SingleUse
,Storage
. Default:SingleUse
.
- intended
Use String - Specifies how the results of an operation will be stored by the caller. Valid values:
SingleUse
,Storage
. Default:SingleUse
.
Import
Using pulumi import
, import aws_location_place_index
resources using the place index name. For example:
$ pulumi import aws:location/placeIndex:PlaceIndex example example
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.