Package software.amazon.awscdk.services.location

Class CfnGeofenceCollection.Builder

java.lang.Object

software.amazon.awscdk.services.location.CfnGeofenceCollection.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGeofenceCollection>

Enclosing class:

CfnGeofenceCollection

@Stability(Stable)
public static final class CfnGeofenceCollection.Builder
extends Object
implements software.amazon.jsii.Builder<CfnGeofenceCollection>

A fluent builder for CfnGeofenceCollection.

Method Summary

Modifier and Type	Method	Description
CfnGeofenceCollection	build()
CfnGeofenceCollection.Builder	collectionName(String collectionName)	A custom name for the geofence collection.
static CfnGeofenceCollection.Builder	create(software.constructs.Construct scope, String id)
CfnGeofenceCollection.Builder	description(String description)	An optional description for the geofence collection.
CfnGeofenceCollection.Builder	kmsKeyId(String kmsKeyId)	A key identifier for an AWS KMS customer managed key .
CfnGeofenceCollection.Builder	pricingPlan(String pricingPlan)	Deprecated. this property has been deprecated
CfnGeofenceCollection.Builder	pricingPlanDataSource(String pricingPlanDataSource)	Deprecated. this property has been deprecated
CfnGeofenceCollection.Builder	tags(List<? extends CfnTag> tags)	Applies one or more tags to the geofence collection.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnGeofenceCollection.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnGeofenceCollection.Builder.

collectionName

@Stability(Stable)
public CfnGeofenceCollection.Builder collectionName(String collectionName)

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 .

Parameters:

collectionName - A custom name for the geofence collection. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnGeofenceCollection.Builder description(String description)

An optional description for the geofence collection.

Parameters:

description - An optional description for the geofence collection. This parameter is required.

Returns:

this

See Also:

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

kmsKeyId

@Stability(Stable)
public CfnGeofenceCollection.Builder kmsKeyId(String kmsKeyId)

A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.

Parameters:

kmsKeyId - A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN. This parameter is required.

Returns:

this

See Also:

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

pricingPlan

@Stability(Deprecated)
@Deprecated
public CfnGeofenceCollection.Builder pricingPlan(String pricingPlan)

Deprecated.

this property has been deprecated

Parameters:

pricingPlan - This parameter is required.

Returns:

this

See Also:

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

pricingPlanDataSource

@Stability(Deprecated)
@Deprecated
public CfnGeofenceCollection.Builder pricingPlanDataSource(String pricingPlanDataSource)

Deprecated.

this property has been deprecated

Parameters:

pricingPlanDataSource - This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnGeofenceCollection.Builder tags(List<? extends CfnTag> tags)

Applies one or more tags to the geofence collection.

A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource
• Each resource tag must be unique with a maximum of one value.
• Maximum key length: 128 Unicode characters in UTF-8
• Maximum value length: 256 Unicode characters in UTF-8
• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : /

Parameters:

tags - Applies one or more tags to the geofence collection. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnGeofenceCollection build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnGeofenceCollection>

Returns:

a newly built instance of CfnGeofenceCollection.