AWS Native v0.108.3, Jun 12 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.location.PlaceIndex

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

pulumi/pulumi-aws-native

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,
               data_source_configuration: Optional[PlaceIndexDataSourceConfigurationArgs] = None,
               description: Optional[str] = None,
               index_name: Optional[str] = None,
               pricing_plan: Optional[PlaceIndexPricingPlan] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native: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.

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const placeIndexResource = new aws_native.location.PlaceIndex("placeIndexResource", {
    dataSource: "string",
    dataSourceConfiguration: {
        intendedUse: aws_native.location.PlaceIndexIntendedUse.SingleUse,
    },
    description: "string",
    indexName: "string",
    pricingPlan: aws_native.location.PlaceIndexPricingPlan.RequestBasedUsage,
    tags: [{
        key: "string",
        value: "string",
    }],
});

Coming soon!

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

The PlaceIndex resource accepts the following input properties:

DataSource string

Specifies the geospatial data provider for the new place index.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

Esri – For additional information about Esri 's coverage in your region of interest, see Esri details on geocoding coverage .
Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps ' coverage, see GrabMaps countries and areas covered .
Here – For additional information about HERE Technologies ' coverage in your region of interest, see HERE details on goecoding coverage .

If you specify HERE Technologies ( Here ) as the data provider, you may not store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service Developer Guide .

DataSourceConfiguration Pulumi.AwsNative.Location.Inputs.PlaceIndexDataSourceConfiguration

Specifies the data storage option requesting Places.

Description string

The optional description for the place index resource.

IndexName string

The name of the place index resource.

Requirements:

Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
Must be a unique place index resource name.
No spaces allowed. For example, ExamplePlaceIndex .

PricingPlan Pulumi.AwsNative.Location.PlaceIndexPricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage .

Allowed Values : RequestBasedUsage

Tags List<Pulumi.AwsNative.Inputs.Tag>

An array of key-value pairs to apply to this resource.

DataSource string

Specifies the geospatial data provider for the new place index.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

Esri – For additional information about Esri 's coverage in your region of interest, see Esri details on geocoding coverage .
Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps ' coverage, see GrabMaps countries and areas covered .
Here – For additional information about HERE Technologies ' coverage in your region of interest, see HERE details on goecoding coverage .

If you specify HERE Technologies ( Here ) as the data provider, you may not store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service Developer Guide .

DataSourceConfiguration PlaceIndexDataSourceConfigurationArgs

Specifies the data storage option requesting Places.

Description string

The optional description for the place index resource.

IndexName string

The name of the place index resource.

Requirements:

Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
Must be a unique place index resource name.
No spaces allowed. For example, ExamplePlaceIndex .

PricingPlan PlaceIndexPricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage .

Allowed Values : RequestBasedUsage

Tags TagArgs

An array of key-value pairs to apply to this resource.

dataSource String

Specifies the geospatial data provider for the new place index.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

Esri – For additional information about Esri 's coverage in your region of interest, see Esri details on geocoding coverage .
Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps ' coverage, see GrabMaps countries and areas covered .
Here – For additional information about HERE Technologies ' coverage in your region of interest, see HERE details on goecoding coverage .

If you specify HERE Technologies ( Here ) as the data provider, you may not store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service Developer Guide .

dataSourceConfiguration PlaceIndexDataSourceConfiguration

Specifies the data storage option requesting Places.

description String

The optional description for the place index resource.

indexName String

The name of the place index resource.

Requirements:

Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
Must be a unique place index resource name.
No spaces allowed. For example, ExamplePlaceIndex .

pricingPlan PlaceIndexPricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage .

Allowed Values : RequestBasedUsage

tags List<Tag>

An array of key-value pairs to apply to this resource.

dataSource string

Specifies the geospatial data provider for the new place index.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

Esri – For additional information about Esri 's coverage in your region of interest, see Esri details on geocoding coverage .
Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps ' coverage, see GrabMaps countries and areas covered .
Here – For additional information about HERE Technologies ' coverage in your region of interest, see HERE details on goecoding coverage .

If you specify HERE Technologies ( Here ) as the data provider, you may not store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service Developer Guide .

dataSourceConfiguration PlaceIndexDataSourceConfiguration

Specifies the data storage option requesting Places.

description string

The optional description for the place index resource.

indexName string

The name of the place index resource.

Requirements:

Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
Must be a unique place index resource name.
No spaces allowed. For example, ExamplePlaceIndex .

pricingPlan PlaceIndexPricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage .

Allowed Values : RequestBasedUsage

tags Tag[]

An array of key-value pairs to apply to this resource.

data_source str

Specifies the geospatial data provider for the new place index.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

Esri – For additional information about Esri 's coverage in your region of interest, see Esri details on geocoding coverage .
Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps ' coverage, see GrabMaps countries and areas covered .
Here – For additional information about HERE Technologies ' coverage in your region of interest, see HERE details on goecoding coverage .

If you specify HERE Technologies ( Here ) as the data provider, you may not store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service Developer Guide .

data_source_configuration PlaceIndexDataSourceConfigurationArgs

Specifies the data storage option requesting Places.

description str

The optional description for the place index resource.

index_name str

The name of the place index resource.

Requirements:

Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
Must be a unique place index resource name.
No spaces allowed. For example, ExamplePlaceIndex .

pricing_plan PlaceIndexPricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage .

Allowed Values : RequestBasedUsage

tags Sequence[TagArgs]

An array of key-value pairs to apply to this resource.

dataSource String

Specifies the geospatial data provider for the new place index.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

Esri – For additional information about Esri 's coverage in your region of interest, see Esri details on geocoding coverage .
Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps ' coverage, see GrabMaps countries and areas covered .
Here – For additional information about HERE Technologies ' coverage in your region of interest, see HERE details on goecoding coverage .

If you specify HERE Technologies ( Here ) as the data provider, you may not store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service Developer Guide .

dataSourceConfiguration Property Map

Specifies the data storage option requesting Places.

description String

The optional description for the place index resource.

indexName String

The name of the place index resource.

Requirements:

Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
Must be a unique place index resource name.
No spaces allowed. For example, ExamplePlaceIndex .

pricingPlan "RequestBasedUsage"

No longer used. If included, the only allowed value is RequestBasedUsage .

Allowed Values : RequestBasedUsage

tags List<Property Map>

An array of key-value pairs to apply to this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the PlaceIndex resource produces the following output properties:

Arn string

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

CreateTime string

The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

Id string

The provider-assigned unique ID for this managed resource.

IndexArn string

Synonym for Arn . The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

UpdateTime string

The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

Arn string

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

CreateTime string

The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

Id string

The provider-assigned unique ID for this managed resource.

IndexArn string

Synonym for Arn . The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

UpdateTime string

The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

arn String

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

createTime String

The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

id String

The provider-assigned unique ID for this managed resource.

indexArn String

Synonym for Arn . The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

updateTime String

The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

arn string

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

createTime string

The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

id string

The provider-assigned unique ID for this managed resource.

indexArn string

Synonym for Arn . The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

updateTime string

The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

arn str

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

create_time str

The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

id str

The provider-assigned unique ID for this managed resource.

index_arn str

Synonym for Arn . The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

update_time str

The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

arn String

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

createTime String

The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

id String

The provider-assigned unique ID for this managed resource.

indexArn String

Synonym for Arn . The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

updateTime String

The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

Supporting Types

PlaceIndexDataSourceConfiguration, PlaceIndexDataSourceConfigurationArgs

IntendedUse Pulumi.AwsNative.Location.PlaceIndexIntendedUse

Specifies how the results of an operation will be stored by the caller.

Valid values include:

SingleUse specifies that the results won't be stored.
Storage specifies that the result can be cached or stored in a database.

Default value: SingleUse

IntendedUse PlaceIndexIntendedUse

Specifies how the results of an operation will be stored by the caller.

Valid values include:

SingleUse specifies that the results won't be stored.
Storage specifies that the result can be cached or stored in a database.

Default value: SingleUse

intendedUse PlaceIndexIntendedUse

Specifies how the results of an operation will be stored by the caller.

Valid values include:

SingleUse specifies that the results won't be stored.
Storage specifies that the result can be cached or stored in a database.

Default value: SingleUse

intendedUse PlaceIndexIntendedUse

Specifies how the results of an operation will be stored by the caller.

Valid values include:

SingleUse specifies that the results won't be stored.
Storage specifies that the result can be cached or stored in a database.

Default value: SingleUse

intended_use PlaceIndexIntendedUse

Specifies how the results of an operation will be stored by the caller.

Valid values include:

SingleUse specifies that the results won't be stored.
Storage specifies that the result can be cached or stored in a database.

Default value: SingleUse

intendedUse "SingleUse" | "Storage"

Specifies how the results of an operation will be stored by the caller.

Valid values include:

SingleUse specifies that the results won't be stored.
Storage specifies that the result can be cached or stored in a database.

Default value: SingleUse

PlaceIndexIntendedUse, PlaceIndexIntendedUseArgs

SingleUse: SingleUse
Storage: Storage

PlaceIndexIntendedUseSingleUse: SingleUse
PlaceIndexIntendedUseStorage: Storage

SingleUse: SingleUse
Storage: Storage

SingleUse: SingleUse
Storage: Storage

SINGLE_USE: SingleUse
STORAGE: Storage

"SingleUse": SingleUse
"Storage": Storage

PlaceIndexPricingPlan, PlaceIndexPricingPlanArgs

RequestBasedUsage: RequestBasedUsage

PlaceIndexPricingPlanRequestBasedUsage: RequestBasedUsage

RequestBasedUsage: RequestBasedUsage

RequestBasedUsage: RequestBasedUsage

REQUEST_BASED_USAGE: RequestBasedUsage

"RequestBasedUsage": RequestBasedUsage

Tag, TagArgs

Key string: The key name of the tag
Value string: The value of the tag

Key string: The key name of the tag
Value string: The value of the tag

key String: The key name of the tag
value String: The value of the tag

key string: The key name of the tag
value string: The value of the tag

key str: The key name of the tag
value str: The value of the tag

key String: The key name of the tag
value String: The value of the tag

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.location.PlaceIndex

On this page

On this page

Create PlaceIndex Resource

Constructor syntax

Parameters

Example

PlaceIndex Resource Properties

Inputs

Outputs

Supporting Types

PlaceIndexDataSourceConfiguration, PlaceIndexDataSourceConfigurationArgs

PlaceIndexIntendedUse, PlaceIndexIntendedUseArgs

PlaceIndexPricingPlan, PlaceIndexPricingPlanArgs

Tag, TagArgs

Package Details

On this page

On this page