@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)", date="2022-08-17T17:31:10.978Z") public class CfnTracker extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnTracker.Builder
A fluent builder for
CfnTracker . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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()
No longer used.
|
java.lang.String |
getPricingPlanDataSource()
This parameter is no longer used.
|
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)
No longer used.
|
void |
setPricingPlanDataSource(java.lang.String value)
This parameter is no longer used.
|
void |
setTrackerName(java.lang.String value)
The name for the tracker resource.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnTracker(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnTracker(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnTracker(Construct scope, java.lang.String id, CfnTrackerProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
Used when you need to specify a resource across all AWS .
arn:aws:geo:region:account-id:tracker/ExampleTracker
public java.lang.String getAttrCreateTime()
public java.lang.String getAttrTrackerArn()
The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS .
arn:aws:geo:region:account-id:tracker/ExampleTracker
public java.lang.String getAttrUpdateTime()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getTrackerName()
Requirements:
ExampleTracker
.public void setTrackerName(java.lang.String value)
Requirements:
ExampleTracker
.public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getKmsKeyId()
public void setKmsKeyId(java.lang.String value)
public java.lang.String getPositionFiltering()
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
.
public void setPositionFiltering(java.lang.String value)
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
.
public java.lang.String getPricingPlan()
If included, the only allowed value is RequestBasedUsage
.
public void setPricingPlan(java.lang.String value)
If included, the only allowed value is RequestBasedUsage
.
public java.lang.String getPricingPlanDataSource()
public void setPricingPlanDataSource(java.lang.String value)