software.amazon.awscdk.services.location

Class CfnTracker

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.location.CfnTracker

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-11T17:58:42.695Z")
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")
         .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	Class and Description
static class	CfnTracker.Builder A fluent builder for CfnTracker.

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTracker(Construct scope, java.lang.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
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) for the tracker resource.
java.lang.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` .
java.lang.String	getAttrTrackerArn() Synonym for `Arn` .
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() An optional description for the tracker resource.
java.lang.String	getKmsKeyId() A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) .
java.lang.String	getPositionFiltering() Specifies the position filtering for the tracker resource.
java.lang.String	getPricingPlan() Specifies the pricing plan for the tracker resource.
java.lang.String	getPricingPlanDataSource() Specifies the data provider for the tracker resource.
java.lang.String	getTrackerName() The name for the tracker resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) An optional description for the tracker resource.
void	setKmsKeyId(java.lang.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(java.lang.String value) Specifies the position filtering for the tracker resource.
void	setPricingPlan(java.lang.String value) Specifies the pricing plan for the tracker resource.
void	setPricingPlanDataSource(java.lang.String value) Specifies the data provider for the tracker resource.
void	setTrackerName(java.lang.String value) The name for the tracker resource.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnTracker(Construct scope,
                  java.lang.String id,
                  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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

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

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

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

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

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getPricingPlan

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

setPricingPlan

public void setPricingPlan(java.lang.String value)

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

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

public void setTrackerName(java.lang.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

public java.lang.String getDescription()

An optional description for the tracker resource.

setDescription

public void setDescription(java.lang.String value)

An optional description for the tracker resource.

getKmsKeyId

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

public void setKmsKeyId(java.lang.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

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

setPositionFiltering

public void setPositionFiltering(java.lang.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.

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

getPricingPlanDataSource

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

setPricingPlanDataSource

public void setPricingPlanDataSource(java.lang.String value)

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