software.amazon.awscdk.services.location

Class CfnTracker

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.location.CfnTracker

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.690Z")
 @Stability(value=Stable)
public class CfnTracker
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Location::Tracker`.

The AWS::Location::Tracker resource specifies a tracker resource in your AWS account , which lets you receive current and historical location of devices.

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.*;
 CfnTracker cfnTracker = CfnTracker.Builder.create(this, "MyCfnTracker")
         .trackerName("trackerName")
         // the properties below are optional
         .description("description")
         .kmsKeyId("kmsKeyId")
         .positionFiltering("positionFiltering")
         .pricingPlan("pricingPlan")
         .pricingPlanDataSource("pricingPlanDataSource")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnTracker.Builder A fluent builder for CfnTracker.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTracker(software.constructs.Construct scope, String id, CfnTrackerProps props) Create a new `AWS::Location::Tracker`.
protected	CfnTracker(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTracker(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) for the tracker resource.
String	getAttrCreateTime() The timestamp for when the tracker resource was created in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .
String	getAttrTrackerArn() Synonym for `Arn` .
String	getAttrUpdateTime() The timestamp for when the tracker resource was last updated in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .
protected Map<String,Object>	getCfnProperties()
String	getDescription() An optional description for the tracker resource.
String	getKmsKeyId() A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) .
String	getPositionFiltering() Specifies the position filtering for the tracker resource.
String	getPricingPlan() No longer used.
String	getPricingPlanDataSource() This parameter is no longer used.
String	getTrackerName() The name for the tracker resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) An optional description for the tracker resource.
void	setKmsKeyId(String value) A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) .
void	setPositionFiltering(String value) Specifies the position filtering for the tracker resource.
void	setPricingPlan(String value) No longer used.
void	setPricingPlanDataSource(String value) This parameter is no longer used.
void	setTrackerName(String value) The name for the tracker resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnTracker

protected CfnTracker(software.amazon.jsii.JsiiObjectRef objRef)

CfnTracker

protected CfnTracker(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnTracker

@Stability(value=Stable)
public CfnTracker(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           CfnTrackerProps props)

Create a new `AWS::Location::Tracker`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) for the tracker resource.

Used when you need to specify a resource across all AWS .

• Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

getAttrCreateTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreateTime()

The timestamp for when the tracker resource was created in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .

getAttrTrackerArn

@Stability(value=Stable)
 @NotNull
public String getAttrTrackerArn()

Synonym for `Arn` .

The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS .

• Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

getAttrUpdateTime

@Stability(value=Stable)
 @NotNull
public String getAttrUpdateTime()

The timestamp for when the tracker resource was last updated in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTrackerName

@Stability(value=Stable)
 @NotNull
public 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 .

setTrackerName

@Stability(value=Stable)
public void setTrackerName(@NotNull
                                                    String value)

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
public String getDescription()

An optional description for the tracker resource.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

An optional description for the tracker resource.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
public 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.

setKmsKeyId

@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)

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
public 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 .

setPositionFiltering

@Stability(value=Stable)
public void setPositionFiltering(@Nullable
                                                          String value)

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 .

getPricingPlan

@Stability(value=Stable)
 @Nullable
public String getPricingPlan()

No longer used.

If included, the only allowed value is RequestBasedUsage .

setPricingPlan

@Stability(value=Stable)
public void setPricingPlan(@Nullable
                                                    String value)

No longer used.

If included, the only allowed value is RequestBasedUsage .

getPricingPlanDataSource

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

This parameter is no longer used.

setPricingPlanDataSource

@Stability(value=Stable)
public void setPricingPlanDataSource(@Nullable
                                                              String value)

This parameter is no longer used.