Skip to content
v2.275.0

Experimental

@aws-cdk/aws-location-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

GeofenceCollectionProps Struct ​

Properties for a geofence collection.

Example ​

ts
declare const key: kms.Key;

new location.GeofenceCollection(this, 'GeofenceCollection', {
  geofenceCollectionName: 'MyGeofenceCollection', // optional, defaults to a generated name
  kmsKey: key, // optional, defaults to use an AWS managed key
});

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description for the geofence collection.

Default: no description

geofenceCollectionNameoptionalstringgeofence_collection_nameoptionalstrgeofenceCollectionNameoptionalStringGeofenceCollectionNameoptionalstringGeofenceCollectionNameoptional*string#
A name for the geofence collection.

Default: A name is automatically generated

Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores.

kmsKeyoptionalIKeyRefkms_keyoptionalIKeyRefkmsKeyoptionalIKeyRefKmsKeyoptionalIKeyRefKmsKeyoptionalIKeyRef#
The customer managed to encrypt your data.

Default: Use an AWS managed key