software.amazon.awscdk.services.location

Class CfnTrackerProps.Builder

java.lang.Object

software.amazon.awscdk.services.location.CfnTrackerProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTrackerProps>

Enclosing interface:

CfnTrackerProps

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

A builder for CfnTrackerProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnTrackerProps	build() Builds the configured instance.
CfnTrackerProps.Builder	description(String description) Sets the value of CfnTrackerProps.getDescription()
CfnTrackerProps.Builder	kmsKeyId(String kmsKeyId) Sets the value of CfnTrackerProps.getKmsKeyId()
CfnTrackerProps.Builder	positionFiltering(String positionFiltering) Sets the value of CfnTrackerProps.getPositionFiltering()
CfnTrackerProps.Builder	pricingPlan(String pricingPlan) Sets the value of CfnTrackerProps.getPricingPlan()
CfnTrackerProps.Builder	pricingPlanDataSource(String pricingPlanDataSource) Sets the value of CfnTrackerProps.getPricingPlanDataSource()
CfnTrackerProps.Builder	trackerName(String trackerName) Sets the value of CfnTrackerProps.getTrackerName()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

pricingPlan

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

Sets the value of CfnTrackerProps.getPricingPlan()

Parameters:

pricingPlan - Specifies the pricing plan for the tracker resource. This parameter is required. For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

Returns:

this

trackerName

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

Sets the value of CfnTrackerProps.getTrackerName()

Parameters:

trackerName - The name for the tracker resource. This parameter is required. 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 .

Returns:

this

description

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

Sets the value of CfnTrackerProps.getDescription()

Parameters:

description - An optional description for the tracker resource.

Returns:

this

kmsKeyId

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

Sets the value of CfnTrackerProps.getKmsKeyId()

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.

Returns:

this

positionFiltering

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

Sets the value of CfnTrackerProps.getPositionFiltering()

Parameters:

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 .

Returns:

this

pricingPlanDataSource

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

Sets the value of CfnTrackerProps.getPricingPlanDataSource()

Parameters:

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

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnTrackerProps

Throws:

NullPointerException - if any required attribute was not provided