class GeofenceCollection (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Location.Alpha.GeofenceCollection
Go	github.com/aws/aws-cdk-go/awscdklocationalpha/v2#GeofenceCollection
Java	software.amazon.awscdk.services.location.alpha.GeofenceCollection
Python	aws_cdk.aws_location_alpha.GeofenceCollection
TypeScript (source)	@aws-cdk/aws-location-alpha » GeofenceCollection

Implements IConstruct, IDependable, IResource, IGeofenceCollection

A Geofence Collection.

See also: https://docs.aws.amazon.com/location/latest/developerguide/geofence-tracker-concepts.html#geofence-overview

Example

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
});

Initializer

new GeofenceCollection(scope: Construct, id: string, props?: GeofenceCollectionProps)

Parameters

• scope Construct
• id string
• props GeofenceCollectionProps

Construct Props

Name	Type	Description
description?🔹	string	A description for the geofence collection.
geofenceCollectionName?🔹	string	A name for the geofence collection.
kmsKey?🔹	IKey	The customer managed to encrypt your data.

---

description?🔹

Type: string (optional, default: no description)

A description for the geofence collection.

---

geofenceCollectionName?🔹

Type: string (optional, default: A name is automatically generated)

A name for the geofence collection.

Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores.

---

kmsKey?🔹

Type: IKey (optional, default: Use an AWS managed key)

The customer managed to encrypt your data.

See also: https://docs.aws.amazon.com/location/latest/developerguide/encryption-at-rest.html

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
geofenceCollectionArn🔹	string	The Amazon Resource Name (ARN) of the geofence collection resource.
geofenceCollectionCreateTime🔹	string	The timestamp for when the geofence collection resource was created in ISO 8601 format.
geofenceCollectionName🔹	string	The name of the geofence collection.
geofenceCollectionUpdateTime🔹	string	The timestamp for when the geofence collection resource was last updated in ISO 8601 format.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.

---

env🔹

Type: ResourceEnvironment

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.

---

geofenceCollectionArn🔹

Type: string

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

---

geofenceCollectionCreateTime🔹

Type: string

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

---

geofenceCollectionName🔹

Type: string

The name of the geofence collection.

---

geofenceCollectionUpdateTime🔹

Type: string

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

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
grant(grantee, ...actions)🔹	Grant the given principal identity permissions to perform the actions on this geofence collection.
grantRead(grantee)🔹	Grant the given identity permissions to read this geofence collection.
toString()🔹	Returns a string representation of this construct.
static fromGeofenceCollectionArn(scope, id, geofenceCollectionArn)🔹	Use an existing geofence collection by ARN.
static fromGeofenceCollectionName(scope, id, geofenceCollectionName)🔹	Use an existing geofence collection by name.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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).

---

grant(grantee, ...actions)🔹

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

• grantee IGrantable
• actions string

Returns

• Grant

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

---

grantRead(grantee)🔹

public grantRead(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grant the given identity permissions to read this geofence collection.

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

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromGeofenceCollectionArn(scope, id, geofenceCollectionArn)🔹

public static fromGeofenceCollectionArn(scope: Construct, id: string, geofenceCollectionArn: string): IGeofenceCollection

Parameters

• scope Construct
• id string
• geofenceCollectionArn string

Returns

• IGeofenceCollection

Use an existing geofence collection by ARN.

---

static fromGeofenceCollectionName(scope, id, geofenceCollectionName)🔹

public static fromGeofenceCollectionName(scope: Construct, id: string, geofenceCollectionName: string): IGeofenceCollection

Parameters

• scope Construct
• id string
• geofenceCollectionName string

Returns

• IGeofenceCollection

Use an existing geofence collection by name.