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	awscc.location.place_indices

Fields

get (all properties)

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.
arn	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
index_name	string
region	string	AWS region.

For more information, see AWS::Location::PlaceIndex.

Methods

Name	Resource	Accessible by	Required Params
create_resource	place_indices	INSERT	DataSource, IndexName, region
delete_resource	place_indices	DELETE	Identifier, region
update_resource	place_indices	UPDATE	Identifier, PatchDocument, region
list_resources	place_indices_list_only	SELECT	region
get_resource	place_indices	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.location.place_indices
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ index_name }}';

list (identifiers only)

Lists all place_indices in a region.

SELECT
  region,
  index_name
FROM awscc.location.place_indices_list_only
WHERE
  region = '{{ region }}';

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 awscc.location.place_indices (
  DataSource,
  IndexName,
  region
)
SELECT
  '{{ data_source }}',
  '{{ index_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.location.place_indices (
  DataSource,
  DataSourceConfiguration,
  Description,
  IndexName,
  PricingPlan,
  Tags,
  region
)
SELECT
  '{{ data_source }}',
  '{{ data_source_configuration }}',
  '{{ description }}',
  '{{ index_name }}',
  '{{ pricing_plan }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: place_index
  props:
    - name: data_source
      value: '{{ data_source }}'
    - name: data_source_configuration
      value:
        intended_use: '{{ intended_use }}'
    - name: description
      value: '{{ description }}'
    - name: index_name
      value: '{{ index_name }}'
    - name: pricing_plan
      value: '{{ pricing_plan }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.location.place_indices
SET PatchDocument = string('{{ {
    "DataSourceConfiguration": data_source_configuration,
    "Description": description,
    "PricingPlan": pricing_plan,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ index_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.location.place_indices
WHERE
  Identifier = '{{ index_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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