software.amazon.awscdk.services.location

Class CfnTrackerProps.Builder

java.lang.Object

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

Enclosing interface:

CfnTrackerProps

public static final class CfnTrackerProps.Builder
extends java.lang.Object

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(java.lang.String description) Sets the value of CfnTrackerProps.getDescription()
CfnTrackerProps.Builder	kmsKeyId(java.lang.String kmsKeyId) Sets the value of CfnTrackerProps.getKmsKeyId()
CfnTrackerProps.Builder	positionFiltering(java.lang.String positionFiltering) Sets the value of CfnTrackerProps.getPositionFiltering()
CfnTrackerProps.Builder	pricingPlan(java.lang.String pricingPlan) Sets the value of CfnTrackerProps.getPricingPlan()
CfnTrackerProps.Builder	pricingPlanDataSource(java.lang.String pricingPlanDataSource) Sets the value of CfnTrackerProps.getPricingPlanDataSource()
CfnTrackerProps.Builder	trackerName(java.lang.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

trackerName

public CfnTrackerProps.Builder trackerName(java.lang.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

public CfnTrackerProps.Builder description(java.lang.String description)

Sets the value of CfnTrackerProps.getDescription()

Parameters:

description - An optional description for the tracker resource.

Returns:

this

kmsKeyId

public CfnTrackerProps.Builder kmsKeyId(java.lang.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

public CfnTrackerProps.Builder positionFiltering(java.lang.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.
• AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.

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

Returns:

this

pricingPlan

public CfnTrackerProps.Builder pricingPlan(java.lang.String pricingPlan)

Sets the value of CfnTrackerProps.getPricingPlan()

Parameters:

pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage .

Returns:

this

pricingPlanDataSource

public CfnTrackerProps.Builder pricingPlanDataSource(java.lang.String pricingPlanDataSource)

Sets the value of CfnTrackerProps.getPricingPlanDataSource()

Parameters:

pricingPlanDataSource - This parameter is no longer used.

Returns:

this

build

public CfnTrackerProps build()

Builds the configured instance.

Returns:

a new instance of CfnTrackerProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided