AWS::Location::PlaceIndex

Specifies a place index resource in your AWS account. Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.

Note

If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the AWS service terms for more details.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Location::PlaceIndex",
  "Properties" : {
      "DataSource" : String,
      "DataSourceConfiguration" : DataSourceConfiguration,
      "Description" : String,
      "IndexName" : String,
      "PricingPlan" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Location::PlaceIndex
Properties:
  DataSource: String
  DataSourceConfiguration: 
    DataSourceConfiguration
  Description: String
  IndexName: String
  PricingPlan: String
  Tags: 
    - Tag

Properties

DataSource

Specifies the geospatial data provider for the new place index.

Note

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.

  Important

  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.

Required: Yes

Type: String

Update requires: Replacement

DataSourceConfiguration

Specifies the data storage option requesting Places.

Required: No

Type: DataSourceConfiguration

Update requires: No interruption

Description

The optional description for the place index resource.

Required: No

Type: String

Minimum: 0

Maximum: 1000

Update requires: No interruption

IndexName

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.

Required: Yes

Type: String

Pattern: ^[-._\w]+$

Minimum: 1

Maximum: 100

Update requires: Replacement

PricingPlan

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

Allowed Values: RequestBasedUsage

Required: No

Type: String

Allowed values: RequestBasedUsage

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the PlaceIndex name.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

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

CreateTime

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

IndexArn

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

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