Package software.amazon.awscdk.services.location

Interface CfnTrackerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTrackerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:45.881Z")
@Stability(Stable)
public interface CfnTrackerProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTracker.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.location.*;
 CfnTrackerProps cfnTrackerProps = CfnTrackerProps.builder()
         .trackerName("trackerName")
         // the properties below are optional
         .description("description")
         .eventBridgeEnabled(false)
         .kmsKeyEnableGeospatialQueries(false)
         .kmsKeyId("kmsKeyId")
         .positionFiltering("positionFiltering")
         .pricingPlan("pricingPlan")
         .pricingPlanDataSource("pricingPlanDataSource")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTrackerProps.Builder	A builder for CfnTrackerProps
static final class	CfnTrackerProps.Jsii$Proxy	An implementation for CfnTrackerProps

Method Summary

Modifier and Type	Method	Description
static CfnTrackerProps.Builder	builder()
default String	getDescription()	An optional description for the tracker resource.
default Object	getEventBridgeEnabled()
default Object	getKmsKeyEnableGeospatialQueries()
default String	getKmsKeyId()	A key identifier for an AWS KMS customer managed key .
default String	getPositionFiltering()	Specifies the position filtering for the tracker resource.
default String	getPricingPlan()	Deprecated. this property has been deprecated
default String	getPricingPlanDataSource()	Deprecated. this property has been deprecated
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
String	getTrackerName()	The name for the tracker resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTrackerName

@Stability(Stable)
@NotNull
String getTrackerName()

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 .

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

An optional description for the tracker resource.

See Also:

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

getEventBridgeEnabled

@Stability(Stable)
@Nullable
default Object getEventBridgeEnabled()

See Also:

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

getKmsKeyEnableGeospatialQueries

@Stability(Stable)
@Nullable
default Object getKmsKeyEnableGeospatialQueries()

See Also:

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

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.

See Also:

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

getPositionFiltering

@Stability(Stable)
@Nullable
default String getPositionFiltering()

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 .

See Also:

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

getPricingPlan

@Stability(Deprecated)
@Deprecated
@Nullable
default String getPricingPlan()

Deprecated.

this property has been deprecated

See Also:

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

getPricingPlanDataSource

@Stability(Deprecated)
@Deprecated
@Nullable
default String getPricingPlanDataSource()

Deprecated.

this property has been deprecated

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

No longer allowed.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnTrackerProps.Builder builder()

Returns:

a CfnTrackerProps.Builder of CfnTrackerProps