GeofenceCollection

class aws_cdk.aws_location_alpha.GeofenceCollection(scope, id, *, description=None, geofence_collection_name=None, kms_key=None)

Bases: Resource

(experimental) A Geofence Collection.

See:: https://docs.aws.amazon.com/location/latest/developerguide/geofence-tracker-concepts.html#geofence-overview
Stability:: experimental
ExampleMetadata:: infused

Example:

# key: kms.Key


location.GeofenceCollection(self, "GeofenceCollection",
    geofence_collection_name="MyGeofenceCollection",  # optional, defaults to a generated name
    kms_key=key
)

Parameters:

scope (Construct) –
id (str) –
description (Optional[str]) – (experimental) A description for the geofence collection. Default: - no description
geofence_collection_name (Optional[str]) – (experimental) A name for the geofence collection. Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores. Default: - A name is automatically generated
kms_key (Optional[IKey]) – (experimental) The customer managed to encrypt your data. Default: - Use an AWS managed key

Stability:

experimental

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

grant(grantee, *actions)

(experimental) Grant the given principal identity permissions to perform the actions on this geofence collection.

Parameters:

grantee (IGrantable) –
actions (str) –

Stability:

experimental

Return type:

Grant

grant_read(grantee)

(experimental) Grant the given identity permissions to read this geofence collection.

Parameters:

grantee (IGrantable) –

See:

https://docs.aws.amazon.com/location/latest/developerguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-read-only-geofences

Stability:

experimental

Return type:

Grant

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

geofence_collection_arn

(experimental) The Amazon Resource Name (ARN) of the geofence collection resource.

Stability:: experimental

geofence_collection_create_time

(experimental) The timestamp for when the geofence collection resource was created in ISO 8601 format.

Stability:: experimental
Attribute:: true

geofence_collection_name

(experimental) The name of the geofence collection.

Stability:: experimental

geofence_collection_update_time

(experimental) The timestamp for when the geofence collection resource was last updated in ISO 8601 format.

Stability:: experimental
Attribute:: true

node: The tree node.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_geofence_collection_arn(scope, id, geofence_collection_arn)

(experimental) Use an existing geofence collection by ARN.

Parameters:

scope (Construct) –
id (str) –
geofence_collection_arn (str) –

Stability:

experimental

Return type:

IGeofenceCollection

classmethod from_geofence_collection_name(scope, id, geofence_collection_name)

(experimental) Use an existing geofence collection by name.

Parameters:

scope (Construct) –
id (str) –
geofence_collection_name (str) –

Stability:

experimental

Return type:

IGeofenceCollection

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool