geofence_collections

Creates, updates, deletes or gets a geofence_collection resource or lists geofence_collections in a region

Overview

Name	geofence_collections
Type	Resource
Description	Definition of AWS::Location::GeofenceCollection Resource Type
Id	aws.location.geofence_collections

Fields

Name	Datatype	Description
collection_arn	string
collection_name	string
create_time	string	The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
description	string
kms_key_id	string
pricing_plan	string
pricing_plan_data_source	string	This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
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	CollectionName, 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 geofence_collections in a region.

SELECT
region,
collection_arn,
collection_name,
create_time,
description,
kms_key_id,
pricing_plan,
pricing_plan_data_source,
tags,
update_time,
arn
FROM aws.location.geofence_collections
WHERE region = 'us-east-1';

Gets all properties from an individual geofence_collection.

SELECT
region,
collection_arn,
collection_name,
create_time,
description,
kms_key_id,
pricing_plan,
pricing_plan_data_source,
tags,
update_time,
arn
FROM aws.location.geofence_collections
WHERE region = 'us-east-1' AND data__Identifier = '<CollectionName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.location.geofence_collections (
 CollectionName,
 region
)
SELECT 
'{{ CollectionName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.location.geofence_collections (
 CollectionName,
 Description,
 KmsKeyId,
 PricingPlan,
 PricingPlanDataSource,
 Tags,
 region
)
SELECT 
 '{{ CollectionName }}',
 '{{ Description }}',
 '{{ KmsKeyId }}',
 '{{ PricingPlan }}',
 '{{ PricingPlanDataSource }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: geofence_collection
    props:
      - name: CollectionName
        value: '{{ CollectionName }}'
      - name: Description
        value: '{{ Description }}'
      - name: KmsKeyId
        value: '{{ KmsKeyId }}'
      - name: PricingPlan
        value: '{{ PricingPlan }}'
      - name: PricingPlanDataSource
        value: '{{ PricingPlanDataSource }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

geo:CreateGeofenceCollection,
geo:DescribeGeofenceCollection,
geo:TagResource,
geo:UntagResource,
kms:DescribeKey,
kms:CreateGrant

Read

geo:DescribeGeofenceCollection,
kms:DescribeKey

Update

geo:CreateGeofenceCollection,
geo:DescribeGeofenceCollection,
geo:TagResource,
geo:UntagResource,
kms:DescribeKey,
kms:CreateGrant,
geo:UpdateGeofenceCollection

Delete

geo:DeleteGeofenceCollection,
geo:DescribeGeofenceCollection

List

geo:ListGeofenceCollections