AWS::Location::GeofenceCollection - AWS CloudFormation
SyntaxPropertiesReturn values

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 AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Location::GeofenceCollection",
  "Properties" : {
      "CollectionName" : String,
      "Description" : String,
      "KmsKeyId" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Location::GeofenceCollection
Properties:
  CollectionName: String
  Description: String
  KmsKeyId: String
  Tags: 
    - Tag

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

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

Minimum: 1

Maximum: 100

Update requires: Replacement

Description

An optional description for the geofence collection.

Required: No

Type: String

Minimum: 0

Maximum: 1000

Update requires: No interruption

KmsKeyId

A key identifier for an AWS 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

Tags

Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

  • Cannot use "aws:" as a prefix for a key.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the GeofenceCollection name.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic 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::GetAtt intrinsic 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 AWS.

  • 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 AWS.

  • 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.