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
, "PricingPlan" :String
, "PricingPlanDataSource" :String
} }
YAML
Type: AWS::Location::GeofenceCollection Properties: CollectionName:
String
Description:String
KmsKeyId:String
PricingPlan:String
PricingPlanDataSource:String
Properties
CollectionName
-
The name for the geofence collection.
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 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: No interruption
PricingPlan
-
No longer used. If included, the only allowed value is
RequestBasedUsage
.Allowed Values:
RequestBasedUsage
Required: No
Type: String
Update requires: Replacement
PricingPlanDataSource
-
This parameter is no longer used.
Required: No
Type: String
Update requires: Replacement
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
.