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.
| Stability | Experimental |
|---|---|
| Source | lib/geofence-collection.ts |
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
});
python
# key: kms.Key
location.GeofenceCollection(self, "GeofenceCollection",
geofence_collection_name="MyGeofenceCollection", # optional, defaults to a generated name
kms_key=key
)
java
Key key;
GeofenceCollection.Builder.create(this, "GeofenceCollection")
.geofenceCollectionName("MyGeofenceCollection") // optional, defaults to a generated name
.kmsKey(key)
.build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Location.Alpha
Key key;
new GeofenceCollection(this, "GeofenceCollection", new GeofenceCollectionProps {
GeofenceCollectionName = "MyGeofenceCollection", // optional, defaults to a generated name
KmsKey = key
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdklocationalpha/v2
var key Key
location.NewGeofenceCollection(this, jsii.String("GeofenceCollection"), &GeofenceCollectionProps{
GeofenceCollectionName: jsii.String("MyGeofenceCollection"),
// optional, defaults to a generated name
KmsKey: 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.