@aws-cdk/aws-location-alpha.GeofenceCollectionProps

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.

GeofenceCollectionProps

used as props by

• GeofenceCollection

Stability

Experimental

Source

lib/geofence-collection.ts

Example

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

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= no description#

A description for the geofence collection.

geofenceCollectionNamestringgeofence_collection_namestrgeofenceCollectionNameStringGeofenceCollectionNamestringGeofenceCollectionName*string= A name is automatically generate…#

A name for the geofence collection.

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

default

Default: A name is automatically generated

kmsKeyIKeyRefkms_keyIKeyRefkmsKeyIKeyRefKmsKeyIKeyRefKmsKeyIKeyRef= Use an AWS managed key#

The customer managed to encrypt your data.