software.amazon.awscdk.services.location

Class CfnGeofenceCollection

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.location.CfnGeofenceCollection

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:24.031Z")
public class CfnGeofenceCollection
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Location::GeofenceCollection`.

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.location.*;
 CfnGeofenceCollection cfnGeofenceCollection = CfnGeofenceCollection.Builder.create(this, "MyCfnGeofenceCollection")
         .collectionName("collectionName")
         // the properties below are optional
         .description("description")
         .kmsKeyId("kmsKeyId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnGeofenceCollection.Builder A fluent builder for CfnGeofenceCollection.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnGeofenceCollection(Construct scope, java.lang.String id, CfnGeofenceCollectionProps props) Create a new `AWS::Location::GeofenceCollection`.
protected	CfnGeofenceCollection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGeofenceCollection(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) for the geofence collection resource.
java.lang.String	getAttrCollectionArn() Synonym for `Arn` .
java.lang.String	getAttrCreateTime() The timestamp for when the geofence collection resource was created in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .
java.lang.String	getAttrUpdateTime() The timestamp for when the geofence collection resource was last updated in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getCollectionName() A custom name for the geofence collection.
java.lang.String	getDescription() An optional description for the geofence collection.
java.lang.String	getKmsKeyId() A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) .
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setCollectionName(java.lang.String value) A custom name for the geofence collection.
void	setDescription(java.lang.String value) An optional description for the geofence collection.
void	setKmsKeyId(java.lang.String value) A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) .

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnGeofenceCollection

protected CfnGeofenceCollection(software.amazon.jsii.JsiiObjectRef objRef)

CfnGeofenceCollection

protected CfnGeofenceCollection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnGeofenceCollection

public CfnGeofenceCollection(Construct scope,
                             java.lang.String id,
                             CfnGeofenceCollectionProps props)

Create a new `AWS::Location::GeofenceCollection`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

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

getAttrCollectionArn

public java.lang.String getAttrCollectionArn()

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

getAttrCreateTime

public java.lang.String getAttrCreateTime()

The timestamp for when the geofence collection resource was created in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .

getAttrUpdateTime

public java.lang.String getAttrUpdateTime()

The timestamp for when the geofence collection resource was last updated in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCollectionName

public java.lang.String getCollectionName()

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 .

setCollectionName

public void setCollectionName(java.lang.String value)

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 .

getDescription

public java.lang.String getDescription()

An optional description for the geofence collection.

setDescription

public void setDescription(java.lang.String value)

An optional description for the geofence collection.

getKmsKeyId

public java.lang.String getKmsKeyId()

A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) . Enter a key ID, key ARN, alias name, or alias ARN.

setKmsKeyId

public void setKmsKeyId(java.lang.String value)

A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) . Enter a key ID, key ARN, alias name, or alias ARN.