CfnGeofenceCollectionProps

class aws_cdk.aws_location.CfnGeofenceCollectionProps(*, collection_name, description=None, kms_key_id=None)

Bases: object

Properties for defining a CfnGeofenceCollection.

Parameters:

  • collection_name (str) – 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 (Optional[str]) – An optional description for the geofence collection.

  • kms_key_id (Optional[str]) – A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-geofencecollection.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_location as location

cfn_geofence_collection_props = location.CfnGeofenceCollectionProps(
    collection_name="collectionName",

    # the properties below are optional
    description="description",
    kms_key_id="kmsKeyId"
)

Attributes

collection_name

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 .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-geofencecollection.html#cfn-location-geofencecollection-collectionname

description

An optional description for the geofence collection.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-geofencecollection.html#cfn-location-geofencecollection-description

kms_key_id

//docs.aws.amazon.com/kms/latest/developerguide/create-keys.html>`_ . Enter a key ID, key ARN, alias name, or alias ARN.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-geofencecollection.html#cfn-location-geofencecollection-kmskeyid

Type:

A key identifier for an `AWS KMS customer managed key <https