Class Tracker

(experimental) A Tracker.

Inheritance

object

Resource

Tracker

Implements

ITracker

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.Location.Alpha

Assembly: Amazon.CDK.AWS.Location.Alpha.dll

Syntax (csharp)

public class Tracker : Resource, ITracker, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class Tracker Inherits Resource Implements ITracker, IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

Stability: Experimental

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

ExampleMetadata: infused

Examples

Role role;


             var tracker = new Tracker(this, "Tracker", new TrackerProps {
                 TrackerName = "MyTracker"
             });

             tracker.GrantRead(role);

Synopsis

Constructors

Tracker(Construct, string, ITrackerProps?)

(experimental) A Tracker.

Properties

PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.
TrackerArn	(experimental) The Amazon Resource Name (ARN) of the tracker resource.
TrackerCreateTime	(experimental) The timestamp for when the tracker resource was created in ISO 8601 format.
TrackerName	(experimental) The name of the tracker.
TrackerUpdateTime	(experimental) The timestamp for when the tracker resource was last updated in ISO 8601 format.

Methods

AddGeofenceCollections(params IGeofenceCollection[])	(experimental) Add Geofence Collections which are associated to the tracker resource.
FromTrackerArn(Construct, string, string)	(experimental) Use an existing tracker by ARN.
FromTrackerName(Construct, string, string)	(experimental) Use an existing tracker by name.
Grant(IGrantable, params string[])	(experimental) Grant the given principal identity permissions to perform the actions on this tracker.
GrantRead(IGrantable)	(experimental) Grant the given identity permissions to read device positions from a tracker.
GrantUpdateDevicePositions(IGrantable)	(experimental) Grant the given identity permissions to update device positions for a tracker.

Constructors

Tracker(Construct, string, ITrackerProps?)

(experimental) A Tracker.

public Tracker(Construct scope, string id, ITrackerProps? props = null)

Parameters

scope Construct
id string
props ITrackerProps

Remarks

Stability: Experimental

Properties

PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

Stability: Experimental

TrackerArn

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

public virtual string TrackerArn { get; }

Property Value

string

Remarks

Stability: Experimental

TrackerCreateTime

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

public virtual string TrackerCreateTime { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

TrackerName

(experimental) The name of the tracker.

public virtual string TrackerName { get; }

Property Value

string

Remarks

Stability: Experimental

TrackerUpdateTime

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

public virtual string TrackerUpdateTime { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

Methods

AddGeofenceCollections(params IGeofenceCollection[])

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

public virtual void AddGeofenceCollections(params IGeofenceCollection[] geofenceCollections)

Parameters

geofenceCollections IGeofenceCollection[]

Remarks

Stability: Experimental

FromTrackerArn(Construct, string, string)

(experimental) Use an existing tracker by ARN.

public static ITracker FromTrackerArn(Construct scope, string id, string trackerArn)

Parameters

scope Construct
id string
trackerArn string

Returns

ITracker

Remarks

Stability: Experimental

FromTrackerName(Construct, string, string)

(experimental) Use an existing tracker by name.

public static ITracker FromTrackerName(Construct scope, string id, string trackerName)

Parameters

scope Construct
id string
trackerName string

Returns

ITracker

Remarks

Stability: Experimental

Grant(IGrantable, params string[])

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

public virtual Grant Grant(IGrantable grantee, params string[] actions)

Parameters

grantee IGrantable
actions string[]

Returns

Grant

Remarks

Stability: Experimental

GrantRead(IGrantable)

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

public virtual Grant GrantRead(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

Remarks

Stability: Experimental

See: 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(IGrantable)

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

public virtual Grant GrantUpdateDevicePositions(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

Remarks

Stability: Experimental

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

Implements

ITracker

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware