CfnGeofenceCollectionProps

class aws_cdk.aws_location.CfnGeofenceCollectionProps(*, collection_name, description=None, kms_key_id=None, pricing_plan=None, pricing_plan_data_source=None, tags=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.

  • pricing_plan (Optional[str]) –

  • pricing_plan_data_source (Optional[str]) – (deprecated) This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them. Format: "key" : "value" Restrictions: - Maximum 50 tags per resource - Each resource tag must be unique with a maximum of one value. - Maximum key length: 128 Unicode characters in UTF-8 - Maximum value length: 256 Unicode characters in UTF-8 - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : /

See:

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.
from aws_cdk import aws_location as location

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

    # the properties below are optional
    description="description",
    kms_key_id="kmsKeyId",
    pricing_plan="pricingPlan",
    pricing_plan_data_source="pricingPlanDataSource",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

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 .

See:

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.

See:

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.

See:

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

pricing_plan

this property has been deprecated

See:

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

Stability:

deprecated

Type:

deprecated

pricing_plan_data_source

Deprecated.

No longer allowed.

Deprecated:

this property has been deprecated

See:

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

Stability:

deprecated

Type:

(deprecated) This shape is deprecated since 2022-02-01

tags

Applies one or more tags to the geofence collection.

A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : /

See:

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

.

  • Cannot use “aws:” as a prefix for a key.