Package software.amazon.awscdk.services.location

Interface CfnGeofenceCollectionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGeofenceCollectionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)",
           date="2023-10-26T00:56:10.074Z")
@Stability(Stable)
public interface CfnGeofenceCollectionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnGeofenceCollection.

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.*;
 CfnGeofenceCollectionProps cfnGeofenceCollectionProps = CfnGeofenceCollectionProps.builder()
         .collectionName("collectionName")
         // the properties below are optional
         .description("description")
         .kmsKeyId("kmsKeyId")
         .pricingPlan("pricingPlan")
         .pricingPlanDataSource("pricingPlanDataSource")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGeofenceCollectionProps.Builder	A builder for CfnGeofenceCollectionProps
static final class	CfnGeofenceCollectionProps.Jsii$Proxy	An implementation for CfnGeofenceCollectionProps

Method Summary

Modifier and Type	Method	Description
static CfnGeofenceCollectionProps.Builder	builder()
String	getCollectionName()	A custom name for the geofence collection.
default String	getDescription()	An optional description for the geofence collection.
default String	getKmsKeyId()	A key identifier for an AWS KMS customer managed key .
default String	getPricingPlan()	Deprecated. this property has been deprecated
default String	getPricingPlanDataSource()	Deprecated. this property has been deprecated

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCollectionName

@Stability(Stable)
@NotNull
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 .

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

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

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

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

getPricingPlan

@Stability(Deprecated)
@Deprecated
@Nullable
default String getPricingPlan()

Deprecated.

this property has been deprecated

See Also:

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

getPricingPlanDataSource

@Stability(Deprecated)
@Deprecated
@Nullable
default String getPricingPlanDataSource()

Deprecated.

this property has been deprecated

See Also:

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

builder

@Stability(Stable)
static CfnGeofenceCollectionProps.Builder builder()

Returns:

a CfnGeofenceCollectionProps.Builder of CfnGeofenceCollectionProps