Package software.amazon.awscdk.services.location.alpha

Class Tracker

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.location.alpha.Tracker

All Implemented Interfaces:

IResource, ITracker, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:18.293Z")
@Stability(Experimental)
public class Tracker
extends Resource
implements ITracker

(experimental) A Tracker.

Example:

 Role role;
 Tracker tracker = Tracker.Builder.create(this, "Tracker")
         .trackerName("MyTracker")
         .build();
 tracker.grantRead(role);
 

See Also:

• https://docs.aws.amazon.com/location/latest/developerguide/geofence-tracker-concepts.html#tracking-overview

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Tracker.Builder	(experimental) A fluent builder for Tracker.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.location.alpha.ITracker

ITracker.Jsii$Default, ITracker.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Tracker(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Tracker(software.amazon.jsii.JsiiObjectRef objRef)
	Tracker(software.constructs.Construct scope, String id)
	Tracker(software.constructs.Construct scope, String id, TrackerProps props)

Method Summary

Modifier and Type	Method	Description
void	addGeofenceCollections(@NotNull IGeofenceCollection... geofenceCollections)	(experimental) Add Geofence Collections which are associated to the tracker resource.
static ITracker	fromTrackerArn(software.constructs.Construct scope, String id, String trackerArn)	(experimental) Use an existing tracker by ARN.
static ITracker	fromTrackerName(software.constructs.Construct scope, String id, String trackerName)	(experimental) Use an existing tracker by name.
String	getTrackerArn()	(experimental) The Amazon Resource Name (ARN) of the tracker resource.
String	getTrackerCreateTime()	(experimental) The timestamp for when the tracker resource was created in ISO 8601 format.
String	getTrackerName()	(experimental) The name of the tracker.
String	getTrackerUpdateTime()	(experimental) The timestamp for when the tracker resource was last updated in ISO 8601 format.
Grant	grant(IGrantable grantee, @NotNull String... actions)	(experimental) Grant the given principal identity permissions to perform the actions on this tracker.
Grant	grantRead(IGrantable grantee)	(experimental) Grant the given identity permissions to read device positions from a tracker.
Grant	grantUpdateDevicePositions(IGrantable grantee)	(experimental) Grant the given identity permissions to update device positions for a tracker.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Tracker

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

Tracker

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

Tracker

@Stability(Experimental)
public Tracker(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 TrackerProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Tracker

@Stability(Experimental)
public Tracker(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

fromTrackerArn

@Stability(Experimental)
@NotNull
public static ITracker fromTrackerArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String trackerArn)

(experimental) Use an existing tracker by ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

trackerArn - This parameter is required.

fromTrackerName

@Stability(Experimental)
@NotNull
public static ITracker fromTrackerName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String trackerName)

(experimental) Use an existing tracker by name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

trackerName - This parameter is required.

addGeofenceCollections

@Stability(Experimental)
public void addGeofenceCollections(@NotNull
 @NotNull IGeofenceCollection... geofenceCollections)

(experimental) Add Geofence Collections which are associated to the tracker resource.

Parameters:

geofenceCollections - This parameter is required.

grant

@Stability(Experimental)
@NotNull
public Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 @NotNull String... actions)

(experimental) Grant the given principal identity permissions to perform the actions on this tracker.

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantRead

@Stability(Experimental)
@NotNull
public Grant grantRead(@NotNull
 IGrantable grantee)

(experimental) Grant the given identity permissions to read device positions from a tracker.

Parameters:

grantee - This parameter is required.

See Also:

• https://docs.aws.amazon.com/location/latest/developerguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-read-only-trackers

grantUpdateDevicePositions

@Stability(Experimental)
@NotNull
public Grant grantUpdateDevicePositions(@NotNull
 IGrantable grantee)

(experimental) Grant the given identity permissions to update device positions for a tracker.

Parameters:

grantee - This parameter is required.

See Also:

• https://docs.aws.amazon.com/location/latest/developerguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-read-only-trackers

getTrackerArn

@Stability(Experimental)
@NotNull
public String getTrackerArn()

(experimental) The Amazon Resource Name (ARN) of the tracker resource.

Specified by:

getTrackerArn in interface ITracker

getTrackerCreateTime

@Stability(Experimental)
@NotNull
public String getTrackerCreateTime()

(experimental) The timestamp for when the tracker resource was created in ISO 8601 format.

getTrackerName

@Stability(Experimental)
@NotNull
public String getTrackerName()

(experimental) The name of the tracker.

Specified by:

getTrackerName in interface ITracker

getTrackerUpdateTime

@Stability(Experimental)
@NotNull
public String getTrackerUpdateTime()

(experimental) The timestamp for when the tracker resource was last updated in ISO 8601 format.