Package 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:
IEnvironmentAware, IInspectable, ITaggableV2, IGeofenceCollectionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:09.228Z") @Stability(Stable) public class CfnGeofenceCollection extends CfnResource implements 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.

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")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnGeofenceCollection

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

    • CfnGeofenceCollection

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

    • CfnGeofenceCollection

      @Stability(Stable) public CfnGeofenceCollection(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnGeofenceCollectionProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromCollectionName

      @Stability(Stable) @NotNull public static IGeofenceCollectionRef fromCollectionName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String collectionName)
      Creates a new IGeofenceCollectionRef from a collectionName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      collectionName - This parameter is required.

    • fromGeofenceCollectionArn

      @Stability(Stable) @NotNull public static IGeofenceCollectionRef fromGeofenceCollectionArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IGeofenceCollectionRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • inspect

      @Stability(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(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(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(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(Stable) @NotNull public String getAttrCreateTime()
      The timestamp for when the geofence collection resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • getAttrUpdateTime

      @Stability(Stable) @NotNull public String getAttrUpdateTime()
      The timestamp for when the geofence collection resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getGeofenceCollectionRef

      @Stability(Stable) @NotNull public GeofenceCollectionReference getGeofenceCollectionRef()
      A reference to a GeofenceCollection resource.
      Specified by:
      getGeofenceCollectionRef in interface IGeofenceCollectionRef

    • getCollectionName

      @Stability(Stable) @NotNull public String getCollectionName()
      A custom name for the geofence collection.

    • setCollectionName

      @Stability(Stable) public void setCollectionName(@NotNull String value)
      A custom name for the geofence collection.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      An optional description for the geofence collection.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      An optional description for the geofence collection.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.

    • getPricingPlan

      @Stability(Deprecated) @Deprecated @Nullable public String getPricingPlan()
      Deprecated.
      this property has been deprecated

    • setPricingPlan

      @Stability(Deprecated) @Deprecated public void setPricingPlan(@Nullable String value)
      Deprecated.
      this property has been deprecated

    • getPricingPlanDataSource

      @Stability(Deprecated) @Deprecated @Nullable public String getPricingPlanDataSource()
      Deprecated.
      this property has been deprecated
      (deprecated) This shape is deprecated since 2022-02-01: Deprecated.

    • setPricingPlanDataSource

      @Stability(Deprecated) @Deprecated public void setPricingPlanDataSource(@Nullable String value)
      Deprecated.
      this property has been deprecated
      (deprecated) This shape is deprecated since 2022-02-01: Deprecated.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Applies one or more tags to the geofence collection.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Applies one or more tags to the geofence collection.