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

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
collection_name	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	geofence_collections	INSERT	CollectionName, region
delete_resource	geofence_collections	DELETE	Identifier, region
update_resource	geofence_collections	UPDATE	Identifier, PatchDocument, region
list_resources	geofence_collections_list_only	SELECT	region
get_resource	geofence_collections	SELECT	Identifier, region

SELECT examples

get (all properties)

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

list (identifiers only)

Lists all geofence_collections in a region.

SELECT
  region,
  collection_name
FROM awscc.location.geofence_collections_list_only
WHERE
  region = '{{ region }}';

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 awscc.location.geofence_collections (
  CollectionName,
  region
)
SELECT
  '{{ collection_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.location.geofence_collections (
  CollectionName,
  Description,
  KmsKeyId,
  PricingPlan,
  PricingPlanDataSource,
  Tags,
  region
)
SELECT
  '{{ collection_name }}',
  '{{ description }}',
  '{{ kms_key_id }}',
  '{{ pricing_plan }}',
  '{{ pricing_plan_data_source }}',
  '{{ 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: geofence_collection
  props:
    - name: collection_name
      value: '{{ collection_name }}'
    - name: description
      value: '{{ description }}'
    - name: kms_key_id
      value: '{{ kms_key_id }}'
    - name: pricing_plan
      value: '{{ pricing_plan }}'
    - name: pricing_plan_data_source
      value: '{{ pricing_plan_data_source }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

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

DELETE example

/*+ delete */
DELETE FROM awscc.location.geofence_collections
WHERE
  Identifier = '{{ collection_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 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