place_indices

Creates, updates, deletes or gets a place_index resource or lists place_indices in a region

Overview

Name	place_indices
Type	Resource
Description	Definition of AWS::Location::PlaceIndex Resource Type
Id	aws.location.place_indices

Fields

Name	Datatype	Description
create_time	string	The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
data_source	string
data_source_configuration	object
description	string
index_arn	string
index_name	string
pricing_plan	string
tags	array	An array of key-value pairs to apply to this resource.
update_time	string	The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
arn	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DataSource, IndexName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all place_indices in a region.

SELECT
region,
create_time,
data_source,
data_source_configuration,
description,
index_arn,
index_name,
pricing_plan,
tags,
update_time,
arn
FROM aws.location.place_indices
WHERE region = 'us-east-1';

Gets all properties from an individual place_index.

SELECT
region,
create_time,
data_source,
data_source_configuration,
description,
index_arn,
index_name,
pricing_plan,
tags,
update_time,
arn
FROM aws.location.place_indices
WHERE region = 'us-east-1' AND data__Identifier = '<IndexName>';

INSERT example

Use the following StackQL query and manifest file to create a new place_index resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.location.place_indices (
 DataSource,
 IndexName,
 region
)
SELECT 
'{{ DataSource }}',
 '{{ IndexName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.location.place_indices (
 DataSource,
 DataSourceConfiguration,
 Description,
 IndexName,
 PricingPlan,
 Tags,
 region
)
SELECT 
 '{{ DataSource }}',
 '{{ DataSourceConfiguration }}',
 '{{ Description }}',
 '{{ IndexName }}',
 '{{ PricingPlan }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: place_index
    props:
      - name: DataSource
        value: '{{ DataSource }}'
      - name: DataSourceConfiguration
        value:
          IntendedUse: '{{ IntendedUse }}'
      - name: Description
        value: '{{ Description }}'
      - name: IndexName
        value: '{{ IndexName }}'
      - name: PricingPlan
        value: '{{ PricingPlan }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.location.place_indices
WHERE data__Identifier = '<IndexName>'
AND region = 'us-east-1';

Permissions

To operate on the place_indices resource, the following permissions are required:

Create

geo:CreatePlaceIndex,
geo:DescribePlaceIndex,
geo:TagResource,
geo:UntagResource

Read

geo:DescribePlaceIndex

Update

geo:CreatePlaceIndex,
geo:DescribePlaceIndex,
geo:TagResource,
geo:UntagResource,
geo:UpdatePlaceIndex

Delete

geo:DeletePlaceIndex,
geo:DescribePlaceIndex

List

geo:ListPlaceIndexes