software.amazon.awscdk.services.location

Class CfnTrackerConsumer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.location.CfnTrackerConsumer

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.691Z")
 @Stability(value=Stable)
public class CfnTrackerConsumer
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Location::TrackerConsumer`.

The AWS::Location::TrackerConsumer resource specifies an association between a geofence collection and a tracker resource. The geofence collection is referred to as the consumer of the tracker. This allows the tracker resource to communicate location data to the linked geofence collection.

Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.

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.*;
 CfnTrackerConsumer cfnTrackerConsumer = CfnTrackerConsumer.Builder.create(this, "MyCfnTrackerConsumer")
         .consumerArn("consumerArn")
         .trackerName("trackerName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnTrackerConsumer.Builder A fluent builder for CfnTrackerConsumer.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTrackerConsumer(software.constructs.Construct scope, String id, CfnTrackerConsumerProps props) Create a new `AWS::Location::TrackerConsumer`.
protected	CfnTrackerConsumer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTrackerConsumer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getConsumerArn() The Amazon Resource Name (ARN) for the geofence collection that consumes the tracker resource updates.
String	getTrackerName() The name for the tracker resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConsumerArn(String value) The Amazon Resource Name (ARN) for the geofence collection that consumes the tracker resource updates.
void	setTrackerName(String value) The name for the tracker resource.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnTrackerConsumer

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

CfnTrackerConsumer

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

CfnTrackerConsumer

@Stability(value=Stable)
public CfnTrackerConsumer(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   CfnTrackerConsumerProps props)

Create a new `AWS::Location::TrackerConsumer`.

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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConsumerArn

@Stability(value=Stable)
 @NotNull
public String getConsumerArn()

The Amazon Resource Name (ARN) for the geofence collection that consumes the tracker resource updates.

• Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer

setConsumerArn

@Stability(value=Stable)
public void setConsumerArn(@NotNull
                                                    String value)

The Amazon Resource Name (ARN) for the geofence collection that consumes the tracker resource updates.

• Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer

getTrackerName

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setTrackerName(@NotNull
                                                    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 .