Experimental

@aws-cdk/aws-location-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

Tracker L2 construct

A Tracker.

Stability: Experimental
Source: lib/tracker.ts

Example

declare const role: iam.Role;

const tracker = new location.Tracker(this, 'Tracker', {
  trackerName: 'MyTracker',
});

tracker.grantRead(role);

python

# role: iam.Role


tracker = location.Tracker(self, "Tracker",
    tracker_name="MyTracker"
)

tracker.grant_read(role)

java

Role role;


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

tracker.grantRead(role);

csharp

// Install: dotnet add package Amazon.CDK.AWS.Location.Alpha
Role role;


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

tracker.GrantRead(role);

// Install: go get github.com/aws/aws-cdk-go/awscdklocationalpha/v2
var role Role


tracker := location.NewTracker(this, jsii.String("Tracker"), &TrackerProps{
	TrackerName: jsii.String("MyTracker"),
})

tracker.GrantRead(role)

Initializer

new Tracker(scope: Construct, id: string, props?: TrackerProps)

python

Tracker(scope: Construct, id: str, props: typing.Optional[TrackerProps] = None)

java

new Tracker(Construct scope, String id, TrackerProps props)

csharp

new Tracker(Construct scope, string id, TrackerProps? props = null)

NewTracker(Scope Construct, Id *string, Props TrackerProps)

Construct Props

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= no description#

A description for the tracker.

eventBridgeEnabledbooleanevent_bridge_enabledbooleventBridgeEnabledBooleanEventBridgeEnabledboolEventBridgeEnabled*bool= false#

Send filtered device position updates to default EventBridge bus.

geofenceCollectionsIGeofenceCollection[]geofence_collectionstyping.List[IGeofenceCollection]geofenceCollectionsList<IGeofenceCollection>GeofenceCollectionsIGeofenceCollection[]GeofenceCollections*[]IGeofenceCollection= no geofence collections are asso…#

An optional list of geofence collections to associate with the tracker resource.

default

Default: no geofence collections are associated

kmsKeyIKeyRefkms_keyIKeyRefkmsKeyIKeyRefKmsKeyIKeyRefKmsKeyIKeyRef= Use an AWS managed key#

The customer managed key to encrypt data.

If you set customer managed key, the Bounding Polygon Queries feature will be disabled by default. You can choose to opt-in to the Bounding Polygon Queries feature by setting the kmsKeyEnableGeospatialQueries parameter to true.

kmsKeyEnableGeospatialQueriesbooleankms_key_enable_geospatial_queriesboolkmsKeyEnableGeospatialQueriesBooleanKmsKeyEnableGeospatialQueriesboolKmsKeyEnableGeospatialQueries*bool= false#

Whether to opt-in to the Bounding Polygon Queries feature with customer managed key.

positionFilteringPositionFilteringposition_filteringPositionFilteringpositionFilteringPositionFilteringPositionFilteringPositionFilteringPositionFilteringPositionFiltering= PositionFiltering.TIME_BASED#

The position filtering for the tracker resource.

trackerNamestringtracker_namestrtrackerNameStringTrackerNamestringTrackerName*string= A name is automatically generate…#

A name for the tracker.

Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores.

default

Default: A name is automatically generated

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#

Uniquely identifies this class.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

trackerArnstringtracker_arnstrtrackerArnStringTrackerArnstringTrackerArn*stringrequired#

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

trackerCreateTimestringtracker_create_timestrtrackerCreateTimeStringTrackerCreateTimestringTrackerCreateTime*stringrequired#

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

trackerNamestringtracker_namestrtrackerNameStringTrackerNamestringTrackerName*stringrequired#

The name of the tracker.

trackerUpdateTimestringtracker_update_timestrtrackerUpdateTimeStringTrackerUpdateTimestringTrackerUpdateTime*stringrequired#

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

Methods

addGeofenceCollections(...geofenceCollections: IGeofenceCollection[]): voiddef add_geofence_collections(self, geofence_collections: IGeofenceCollection) -> Nonepublic void addGeofenceCollections(IGeofenceCollection geofenceCollections)public void AddGeofenceCollections(IGeofenceCollection geofenceCollections)func AddGeofenceCollections(GeofenceCollections IGeofenceCollection)#

Add Geofence Collections which are associated to the tracker resource.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

fromTrackerArn(scope: Construct, id: string, trackerArn: string): ITracker@staticmethod def from_tracker_arn(scope: Construct, id: str, tracker_arn: str) -> ITrackerpublic static ITracker fromTrackerArn(Construct scope, String id, String trackerArn)public static ITracker FromTrackerArn(Construct scope, string id, string trackerArn)func FromTrackerArn(Scope Construct, Id *string, TrackerArn *string) ITrackerstatic#

Use an existing tracker by ARN.

fromTrackerName(scope: Construct, id: string, trackerName: string): ITracker@staticmethod def from_tracker_name(scope: Construct, id: str, tracker_name: str) -> ITrackerpublic static ITracker fromTrackerName(Construct scope, String id, String trackerName)public static ITracker FromTrackerName(Construct scope, string id, string trackerName)func FromTrackerName(Scope Construct, Id *string, TrackerName *string) ITrackerstatic#

Use an existing tracker by name.

grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#

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

[disable-awslint:no-grants]

grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#

Grant the given identity permissions to read device positions from a tracker [disable-awslint:no-grants].

grantUpdateDevicePositions(grantee: IGrantable): Grantdef grant_update_device_positions(self, grantee: IGrantable) -> Grantpublic Grant grantUpdateDevicePositions(IGrantable grantee)public Grant GrantUpdateDevicePositions(IGrantable grantee)func GrantUpdateDevicePositions(Grantee IGrantable) Grant#

Grant the given identity permissions to update device positions for a tracker [disable-awslint:no-grants].

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Tracker L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​