software.amazon.awscdk.services.location

Class CfnGeofenceCollection

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.location.CfnGeofenceCollection

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.671Z")
 @Stability(value=Stable)
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")
         .pricingPlan("pricingPlan")
         .pricingPlanDataSource("pricingPlanDataSource")
         .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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnGeofenceCollection(software.constructs.Construct scope, 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
String	getAttrArn() The Amazon Resource Name (ARN) for the geofence collection resource.
String	getAttrCollectionArn() Synonym for `Arn` .
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` .
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 Map<String,Object>	getCfnProperties()
String	getCollectionName() The name for the geofence collection.
String	getDescription() An optional description for the geofence collection.
String	getKmsKeyId() A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) .
String	getPricingPlan() No longer used.
String	getPricingPlanDataSource() This parameter is no longer used.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCollectionName(String value) The name for the geofence collection.
void	setDescription(String value) An optional description for the geofence collection.
void	setKmsKeyId(String value) A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) .
void	setPricingPlan(String value) No longer used.
void	setPricingPlanDataSource(String value) This parameter is no longer used.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnGeofenceCollection(@NotNull
                                                      software.constructs.Construct scope,
                                                      @NotNull
                                                      String id,
                                                      @NotNull
                                                      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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCollectionName

@Stability(value=Stable)
 @NotNull
public String getCollectionName()

The name for the geofence collection.

setCollectionName

@Stability(value=Stable)
public void setCollectionName(@NotNull
                                                       String value)

The name for the geofence collection.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

An optional description for the geofence collection.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

An optional description for the geofence collection.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 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.

getPricingPlan

@Stability(value=Stable)
 @Nullable
public String getPricingPlan()

No longer used. If included, the only allowed value is `RequestBasedUsage` .

Allowed Values : RequestBasedUsage

setPricingPlan

@Stability(value=Stable)
public void setPricingPlan(@Nullable
                                                    String value)

No longer used. If included, the only allowed value is `RequestBasedUsage` .

Allowed Values : RequestBasedUsage

getPricingPlanDataSource

@Stability(value=Stable)
 @Nullable
public String getPricingPlanDataSource()

This parameter is no longer used.

setPricingPlanDataSource

@Stability(value=Stable)
public void setPricingPlanDataSource(@Nullable
                                                              String value)

This parameter is no longer used.