software.amazon.awscdk.services.location

Class CfnTracker.Builder

java.lang.Object

software.amazon.awscdk.services.location.CfnTracker.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTracker>

Enclosing class:

CfnTracker

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

A fluent builder for CfnTracker.

Method Summary

Modifier and Type	Method and Description
CfnTracker	build()
static CfnTracker.Builder	create(Construct scope, String id)
CfnTracker.Builder	description(String description) An optional description for the tracker resource.
CfnTracker.Builder	kmsKeyId(String kmsKeyId) A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) .
CfnTracker.Builder	positionFiltering(String positionFiltering) Specifies the position filtering for the tracker resource.
CfnTracker.Builder	pricingPlan(String pricingPlan) Specifies the pricing plan for the tracker resource.
CfnTracker.Builder	pricingPlanDataSource(String pricingPlanDataSource) Specifies the data provider for the tracker resource.
CfnTracker.Builder	trackerName(String trackerName) The name for the tracker resource.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnTracker.Builder create(Construct scope,
                                                                 String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnTracker.Builder.

pricingPlan

@Stability(value=Stable)
public CfnTracker.Builder pricingPlan(String pricingPlan)

Specifies the pricing plan for the tracker resource.

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

Parameters:

pricingPlan - Specifies the pricing plan for the tracker resource. This parameter is required.

Returns:

this

trackerName

@Stability(value=Stable)
public CfnTracker.Builder trackerName(String trackerName)

The name for the tracker resource.

Requirements:

• Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).
• Must be a unique tracker resource name.
• No spaces allowed. For example, ExampleTracker .

Parameters:

trackerName - The name for the tracker resource. This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public CfnTracker.Builder description(String description)

An optional description for the tracker resource.

Parameters:

description - An optional description for the tracker resource. This parameter is required.

Returns:

this

kmsKeyId

@Stability(value=Stable)
public CfnTracker.Builder kmsKeyId(String kmsKeyId)

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.

Parameters:

kmsKeyId - 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. This parameter is required.

Returns:

this

positionFiltering

@Stability(value=Stable)
public CfnTracker.Builder positionFiltering(String positionFiltering)

Specifies the position filtering for the tracker resource.

Valid values:

• TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.
• DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.

This field is optional. If not specified, the default value is TimeBased .

Parameters:

positionFiltering - Specifies the position filtering for the tracker resource. This parameter is required.

Returns:

this

pricingPlanDataSource

@Stability(value=Stable)
public CfnTracker.Builder pricingPlanDataSource(String pricingPlanDataSource)

Specifies the data provider for the tracker resource.

• 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 tracker resource. 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

Parameters:

pricingPlanDataSource - Specifies the data provider for the tracker resource. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnTracker build()

Specified by:

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