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.50.0 (build d1830a4)",
           date="2022-01-04T15:39:11.808Z")
 @Stability(value=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")
         .pricingPlan("pricingPlan")
         // the properties below are optional
         .description("description")
         .kmsKeyId("kmsKeyId")
         .pricingPlanDataSource("pricingPlanDataSource")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnGeofenceCollectionProps.Builder	builder()
String	getCollectionName() The 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](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) .
String	getPricingPlan() Specifies the pricing plan for the geofence collection.
default String	getPricingPlanDataSource() Specifies the data provider for the geofence collection.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCollectionName

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

The name for the geofence collection.

getPricingPlan

@Stability(value=Stable)
 @NotNull
String getPricingPlan()

Specifies the pricing plan for the geofence collection.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

getDescription

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

An optional description for the geofence collection.

getKmsKeyId

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

getPricingPlanDataSource

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

Specifies the data provider for the geofence collection.

• Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement

For more information about Data Providers , and Pricing plans , see the Amazon Location Service product page.

Amazon Location Service only uses PricingPlanDataSource to calculate billing for your geofence collection. Your data will not be shared with the data provider, and will remain in your AWS account or region unless you move it.

Valid Values: Esri | Here

builder

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

Returns:

a CfnGeofenceCollectionProps.Builder of CfnGeofenceCollectionProps