Package software.amazon.awscdk.cfnpropertymixins.services.location

Class CfnTrackerPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.location.CfnTrackerPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTrackerPropsMixin>

Enclosing class:

CfnTrackerPropsMixin

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

A fluent builder for CfnTrackerPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnTrackerPropsMixin	build()
static CfnTrackerPropsMixin.Builder	create()
static CfnTrackerPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnTrackerPropsMixin.Builder	description(String description)	An optional description for the tracker resource.
CfnTrackerPropsMixin.Builder	eventBridgeEnabled(Boolean eventBridgeEnabled)
CfnTrackerPropsMixin.Builder	eventBridgeEnabled(IResolvable eventBridgeEnabled)
CfnTrackerPropsMixin.Builder	kmsKeyEnableGeospatialQueries(Boolean kmsKeyEnableGeospatialQueries)
CfnTrackerPropsMixin.Builder	kmsKeyEnableGeospatialQueries(IResolvable kmsKeyEnableGeospatialQueries)
CfnTrackerPropsMixin.Builder	kmsKeyId(String kmsKeyId)	A key identifier for an AWS KMS customer managed key .
CfnTrackerPropsMixin.Builder	positionFiltering(String positionFiltering)	Specifies the position filtering for the tracker resource.
CfnTrackerPropsMixin.Builder	pricingPlan(String pricingPlan)	Deprecated. this property has been deprecated
CfnTrackerPropsMixin.Builder	pricingPlanDataSource(String pricingPlanDataSource)	Deprecated. this property has been deprecated
CfnTrackerPropsMixin.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.
CfnTrackerPropsMixin.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 Details

create

@Stability(Stable)
public static CfnTrackerPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnTrackerPropsMixin.Builder.

create

@Stability(Stable)
public static CfnTrackerPropsMixin.Builder create()

Returns:

a new instance of CfnTrackerPropsMixin.Builder.

description

@Stability(Stable)
public CfnTrackerPropsMixin.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

See Also:

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

eventBridgeEnabled

@Stability(Stable)
public CfnTrackerPropsMixin.Builder eventBridgeEnabled(Boolean eventBridgeEnabled)

Parameters:

eventBridgeEnabled - This parameter is required.

Returns:

this

See Also:

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

eventBridgeEnabled

@Stability(Stable)
public CfnTrackerPropsMixin.Builder eventBridgeEnabled(IResolvable eventBridgeEnabled)

Parameters:

eventBridgeEnabled - This parameter is required.

Returns:

this

See Also:

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

kmsKeyEnableGeospatialQueries

@Stability(Stable)
public CfnTrackerPropsMixin.Builder kmsKeyEnableGeospatialQueries(Boolean kmsKeyEnableGeospatialQueries)

Parameters:

kmsKeyEnableGeospatialQueries - This parameter is required.

Returns:

this

See Also:

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

kmsKeyEnableGeospatialQueries

@Stability(Stable)
public CfnTrackerPropsMixin.Builder kmsKeyEnableGeospatialQueries(IResolvable kmsKeyEnableGeospatialQueries)

Parameters:

kmsKeyEnableGeospatialQueries - This parameter is required.

Returns:

this

See Also:

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

kmsKeyId

@Stability(Stable)
public CfnTrackerPropsMixin.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-tracker.html#cfn-location-tracker-kmskeyid

positionFiltering

@Stability(Stable)
public CfnTrackerPropsMixin.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.
• 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

See Also:

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

pricingPlan

@Stability(Deprecated)
@Deprecated
public CfnTrackerPropsMixin.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-tracker.html#cfn-location-tracker-pricingplan

pricingPlanDataSource

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

Deprecated.

this property has been deprecated

(deprecated) This shape is deprecated since 2022-02-01: Deprecated.

No longer allowed.

Parameters:

pricingPlanDataSource - This shape is deprecated since 2022-02-01: Deprecated. This parameter is required.

Returns:

this

See Also:

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

tags

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

An array of key-value pairs to apply to this resource.

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

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

trackerName

@Stability(Stable)
public CfnTrackerPropsMixin.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

See Also:

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

build

@Stability(Stable)
public CfnTrackerPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnTrackerPropsMixin.