aws-cdk-lib.aws_location.CfnGeofenceCollectionProps

interface CfnGeofenceCollectionProps

LanguageType name
.NETAmazon.CDK.AWS.Location.CfnGeofenceCollectionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslocation#CfnGeofenceCollectionProps
Javasoftware.amazon.awscdk.services.location.CfnGeofenceCollectionProps
Pythonaws_cdk.aws_location.CfnGeofenceCollectionProps
TypeScript aws-cdk-lib » aws_location » CfnGeofenceCollectionProps

Properties for defining a CfnGeofenceCollection.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_location as location } from 'aws-cdk-lib';
const cfnGeofenceCollectionProps: location.CfnGeofenceCollectionProps = {
  collectionName: 'collectionName',

  // the properties below are optional
  description: 'description',
  kmsKeyId: 'kmsKeyId',
};

Properties

NameTypeDescription
collectionNamestringA custom name for the geofence collection.
description?stringAn optional description for the geofence collection.
kmsKeyId?stringA key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.

collectionName

Type: string

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 .

description?

Type: string (optional)

An optional description for the geofence collection.


kmsKeyId?

Type: string (optional)

A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.