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.50.0 (build d1830a4)",
           date="2022-01-04T15:39:11.839Z")
 @Stability(value=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()
         .pricingPlan("pricingPlan")
         .trackerName("trackerName")
         // the properties below are optional
         .description("description")
         .kmsKeyId("kmsKeyId")
         .positionFiltering("positionFiltering")
         .pricingPlanDataSource("pricingPlanDataSource")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnTrackerProps.Builder	builder()
default String	getDescription() An optional description for the tracker resource.
default String	getKmsKeyId() A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) .
default String	getPositionFiltering() Specifies the position filtering for the tracker resource.
String	getPricingPlan() Specifies the pricing plan for the tracker resource.
default String	getPricingPlanDataSource() Specifies the data provider for the tracker resource.
String	getTrackerName() The name for the tracker resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPricingPlan

@Stability(value=Stable)
 @NotNull
String getPricingPlan()

Specifies the pricing plan for the tracker resource.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page .

getTrackerName

@Stability(value=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 .

getDescription

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

An optional description for the tracker resource.

getKmsKeyId

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

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.

getPositionFiltering

@Stability(value=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.

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

getPricingPlanDataSource

@Stability(value=Stable)
 @Nullable
default String getPricingPlanDataSource()

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

builder

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

Returns:

a CfnTrackerProps.Builder of CfnTrackerProps