AWS::Location::PlaceIndex
The AWS::Location::PlaceIndex
resource specifies a place index resource
in your AWS account, which supports Places functions with geospatial
data sourced from your chosen data provider.
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
} }
YAML
Type: AWS::Location::PlaceIndex Properties: DataSource:
String
DataSourceConfiguration:DataSourceConfiguration
Description:String
IndexName:String
PricingPlan:String
Properties
DataSource
-
Specifies the data provider of geospatial data.
Note This field is case-sensitive. Enter the valid values as shown. For example, entering
HERE
will return an error.Valid values include:
-
Esri
-
Here
Important Place index resources using HERE as a data provider can't be used to store results for locations in Japan. For more information, see the AWS Service Terms
for Amazon Location Service.
For additional details on data providers, see the Amazon Location Service data providers page.
Required: Yes
Type: String
Update requires: Replacement
-
DataSourceConfiguration
-
Specifies the data storage option for requesting Places.
Required: No
Type: DataSourceConfiguration
Update requires: Replacement
Description
-
The optional description for the place index resource.
Required: No
Type: String
Minimum:
0
Maximum:
1000
Update requires: Replacement
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
Minimum:
1
Maximum:
100
Pattern:
^[-._\w]+$
Update requires: Replacement
-
PricingPlan
-
No longer used. If included, the only allowed value is
RequestBasedUsage
.Allowed Values:
RequestBasedUsage
Required: No
Type: String
Update requires: Replacement
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
.