class CfnGeofenceCollection (construct)

Language	Type name
.NET	Amazon.CDK.AWS.Location.CfnGeofenceCollection
Go	github.com/aws/aws-cdk-go/awscdk/v2/awslocation#CfnGeofenceCollection
Java	software.amazon.awscdk.services.location.CfnGeofenceCollection
Python	aws_cdk.aws_location.CfnGeofenceCollection
TypeScript	aws-cdk-lib » aws_location » CfnGeofenceCollection

Implements IConstruct, IDependable, IInspectable, IGeofenceCollectionRef, ITaggableV2

The AWS::Location::GeofenceCollection resource specifies the ability to detect and act when a tracked device enters or exits a defined geographical boundary known as a geofence.

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

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 cfnGeofenceCollection = new location.CfnGeofenceCollection(this, 'MyCfnGeofenceCollection', {
  collectionName: 'collectionName',

  // the properties below are optional
  description: 'description',
  kmsKeyId: 'kmsKeyId',
  pricingPlan: 'pricingPlan',
  pricingPlanDataSource: 'pricingPlanDataSource',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnGeofenceCollection(scope: Construct, id: string, props: CfnGeofenceCollectionProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnGeofenceCollectionProps — Resource properties.

Construct Props

Name	Type	Description
collectionName	string	A custom name for the geofence collection.
description?	string	An optional description for the geofence collection.
kmsKeyId?	string	A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.
pricingPlan?⚠️	string
pricingPlanDataSource?⚠️	string	This shape is deprecated since 2022-02-01: Deprecated.
tags?	CfnTag[]	Applies one or more tags to the geofence collection.

---

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 .

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

---

description?

Type: string (optional)

An optional description for the geofence collection.

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

---

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.

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

---

pricingPlan?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string (optional)

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

---

pricingPlanDataSource?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string (optional)

This shape is deprecated since 2022-02-01: Deprecated.

No longer allowed.

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

---

tags?

Type: CfnTag[] (optional)

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-geofencecollection.html#cfn-location-geofencecollection-tags

Properties

Name	Type	Description
attrArn	string	The Amazon Resource Name (ARN) for the geofence collection resource.
attrCollectionArn	string	Synonym for Arn .
attrCreateTime	string	The timestamp for when the geofence collection resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
attrUpdateTime	string	The timestamp for when the geofence collection resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
cdkTagManager	TagManager	Tag Manager which manages the tags for this resource.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
collectionName	string	A custom name for the geofence collection.
creationStack	string[]
geofenceCollectionRef	GeofenceCollectionReference	A reference to a GeofenceCollection resource.
logicalId	string	The logical ID for this CloudFormation stack element.
node	Node	The tree node.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
stack	Stack	The stack in which this element is defined.
description?	string	An optional description for the geofence collection.
kmsKeyId?	string	A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.
pricingPlan?⚠️	string
pricingPlanDataSource?⚠️	string	This shape is deprecated since 2022-02-01: Deprecated.
tags?	CfnTag[]	Applies one or more tags to the geofence collection.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrArn

Type: string

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

Used when you need to specify a resource across all AWS .

• Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

---

attrCollectionArn

Type: string

Synonym for Arn .

The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS .

• Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

---

attrCreateTime

Type: string

The timestamp for when the geofence collection resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

---

attrUpdateTime

Type: string

The timestamp for when the geofence collection resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

---

cdkTagManager

Type: TagManager

Tag Manager which manages the tags for this resource.

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

collectionName

Type: string

A custom name for the geofence collection.

---

creationStack

Type: string[]

---

geofenceCollectionRef

Type: GeofenceCollectionReference

A reference to a GeofenceCollection resource.

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

node

Type: Node

The tree node.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

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.

---

pricingPlan?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string (optional)

---

pricingPlanDataSource?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string (optional)

This shape is deprecated since 2022-02-01: Deprecated.

---

tags?

Type: CfnTag[] (optional)

Applies one or more tags to the geofence collection.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)
static fromCollectionName(scope, id, collectionName)	Creates a new IGeofenceCollectionRef from a collectionName.
static fromGeofenceCollectionArn(scope, id, arn)	Creates a new IGeofenceCollectionRef from an ARN.

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): (Stack | CfnResource)[]

Returns

• (Stack | CfnResource)[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }

---

static fromCollectionName(scope, id, collectionName)

public static fromCollectionName(scope: Construct, id: string, collectionName: string): IGeofenceCollectionRef

Parameters

• scope Construct
• id string
• collectionName string

Returns

• IGeofenceCollectionRef

Creates a new IGeofenceCollectionRef from a collectionName.

---

static fromGeofenceCollectionArn(scope, id, arn)

public static fromGeofenceCollectionArn(scope: Construct, id: string, arn: string): IGeofenceCollectionRef

Parameters

• scope Construct
• id string
• arn string

Returns

• IGeofenceCollectionRef

Creates a new IGeofenceCollectionRef from an ARN.