AWS::Location::GeofenceCollection - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Location::GeofenceCollection

The AWS::Location::GeofenceCollection resource specifies the ability to detect and act when a tracked device enters or exits a defined geographical boundary known as a geofence.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Location::GeofenceCollection",
  "Properties" : {
      "CollectionName" : String,
      "Description" : String,
      "KmsKeyId" : String
    }
}

YAML

Type: AWS::Location::GeofenceCollection
Properties: 
  CollectionName: String
  Description: String
  KmsKeyId: String

Properties

CollectionName

A custom name for the geofence collection.

Requirements:

  • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

  • Must be a unique geofence collection name.

  • No spaces allowed. For example, ExampleGeofenceCollection.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Pattern: ^[-._\w]+$

Update requires: Replacement

Description

An optional description for the geofence collection.

Required: No

Type: String

Minimum: 0

Maximum: 1000

Update requires: Replacement

KmsKeyId

A key identifier for an Amazon KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the GeofenceCollection name.

For more information about using the Reffunction, see Ref.

Fn::GetAtt

The Fn::GetAttintrinsic 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::GetAttintrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon.

  • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

CollectionArn

Synonym for Arn. The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon.

  • Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

CreateTime

The timestamp for when the geofence collection resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

UpdateTime

The timestamp for when the geofence collection resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.