software.amazon.awscdk.services.location

Class CfnTracker.Builder

java.lang.Object

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

Enclosing class:

CfnTracker

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

A fluent builder for CfnTracker.

Method Summary

Modifier and Type	Method and Description
CfnTracker	build()
static CfnTracker.Builder	create(Construct scope, java.lang.String id)
CfnTracker.Builder	description(java.lang.String description) An optional description for the tracker resource.
CfnTracker.Builder	kmsKeyId(java.lang.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(java.lang.String positionFiltering) Specifies the position filtering for the tracker resource.
CfnTracker.Builder	pricingPlan(java.lang.String pricingPlan) No longer used.
CfnTracker.Builder	pricingPlanDataSource(java.lang.String pricingPlanDataSource) This parameter is no longer used.
CfnTracker.Builder	trackerName(java.lang.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

public static CfnTracker.Builder create(Construct scope,
                                        java.lang.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.

trackerName

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

public CfnTracker.Builder description(java.lang.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

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

public CfnTracker.Builder positionFiltering(java.lang.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.
• 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 .

Parameters:

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

Returns:

this

pricingPlan

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

No longer used.

If included, the only allowed value is RequestBasedUsage .

Parameters:

pricingPlan - No longer used. This parameter is required.

Returns:

this

pricingPlanDataSource

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

This parameter is no longer used.

Parameters:

pricingPlanDataSource - This parameter is no longer used. This parameter is required.

Returns:

this

build

public CfnTracker build()