awslocation

package
v1.146.0-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 25, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnGeofenceCollection_CFN_RESOURCE_TYPE_NAME 

func CfnGeofenceCollection_CFN_RESOURCE_TYPE_NAME() *string

func CfnGeofenceCollection_IsCfnElement 

func CfnGeofenceCollection_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnGeofenceCollection_IsCfnResource 

func CfnGeofenceCollection_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnGeofenceCollection_IsConstruct 

func CfnGeofenceCollection_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnMap_CFN_RESOURCE_TYPE_NAME 

func CfnMap_CFN_RESOURCE_TYPE_NAME() *string

func CfnMap_IsCfnElement 

func CfnMap_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnMap_IsCfnResource 

func CfnMap_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnMap_IsConstruct 

func CfnMap_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnPlaceIndex_CFN_RESOURCE_TYPE_NAME 

func CfnPlaceIndex_CFN_RESOURCE_TYPE_NAME() *string

func CfnPlaceIndex_IsCfnElement 

func CfnPlaceIndex_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnPlaceIndex_IsCfnResource 

func CfnPlaceIndex_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnPlaceIndex_IsConstruct 

func CfnPlaceIndex_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnRouteCalculator_CFN_RESOURCE_TYPE_NAME 

func CfnRouteCalculator_CFN_RESOURCE_TYPE_NAME() *string

func CfnRouteCalculator_IsCfnElement 

func CfnRouteCalculator_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnRouteCalculator_IsCfnResource 

func CfnRouteCalculator_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnRouteCalculator_IsConstruct 

func CfnRouteCalculator_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnTrackerConsumer_CFN_RESOURCE_TYPE_NAME 

func CfnTrackerConsumer_CFN_RESOURCE_TYPE_NAME() *string

func CfnTrackerConsumer_IsCfnElement 

func CfnTrackerConsumer_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnTrackerConsumer_IsCfnResource 

func CfnTrackerConsumer_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnTrackerConsumer_IsConstruct 

func CfnTrackerConsumer_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnTracker_CFN_RESOURCE_TYPE_NAME 

func CfnTracker_CFN_RESOURCE_TYPE_NAME() *string

func CfnTracker_IsCfnElement 

func CfnTracker_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnTracker_IsCfnResource 

func CfnTracker_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnTracker_IsConstruct 

func CfnTracker_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnGeofenceCollection_Override 

func NewCfnGeofenceCollection_Override(c CfnGeofenceCollection, scope awscdk.Construct, id *string, props *CfnGeofenceCollectionProps)

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

func NewCfnMap_Override 

func NewCfnMap_Override(c CfnMap, scope awscdk.Construct, id *string, props *CfnMapProps)

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

func NewCfnPlaceIndex_Override 

func NewCfnPlaceIndex_Override(c CfnPlaceIndex, scope awscdk.Construct, id *string, props *CfnPlaceIndexProps)

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

func NewCfnRouteCalculator_Override 

func NewCfnRouteCalculator_Override(c CfnRouteCalculator, scope awscdk.Construct, id *string, props *CfnRouteCalculatorProps)

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

func NewCfnTrackerConsumer_Override 

func NewCfnTrackerConsumer_Override(c CfnTrackerConsumer, scope awscdk.Construct, id *string, props *CfnTrackerConsumerProps)

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

func NewCfnTracker_Override 

func NewCfnTracker_Override(c CfnTracker, scope awscdk.Construct, id *string, props *CfnTrackerProps)

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

Types

type CfnGeofenceCollection 

type CfnGeofenceCollection interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrCollectionArn() *string
	AttrCreateTime() *string
	AttrUpdateTime() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CollectionName() *string
	SetCollectionName(val *string)
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	KmsKeyId() *string
	SetKmsKeyId(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	PricingPlan() *string
	SetPricingPlan(val *string)
	PricingPlanDataSource() *string
	SetPricingPlanDataSource(val *string)
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Location::GeofenceCollection`.

The `AWS::Location::GeofenceCollection` resource specifies the ability to detect and act when a tracked device enters or exits a defined geographical boundary known as a geofence.

TODO: EXAMPLE

func NewCfnGeofenceCollection 

func NewCfnGeofenceCollection(scope awscdk.Construct, id *string, props *CfnGeofenceCollectionProps) CfnGeofenceCollection

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

type CfnGeofenceCollectionProps 

type CfnGeofenceCollectionProps struct {
	// The name for the geofence collection.
	CollectionName *string `json:"collectionName" yaml:"collectionName"`
	// An optional description for the geofence collection.
	Description *string `json:"description" yaml:"description"`
	// A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) . Enter a key ID, key ARN, alias name, or alias ARN.
	KmsKeyId *string `json:"kmsKeyId" yaml:"kmsKeyId"`
	// No longer used. If included, the only allowed value is `RequestBasedUsage` .
	//
	// *Allowed Values* : `RequestBasedUsage`
	PricingPlan *string `json:"pricingPlan" yaml:"pricingPlan"`
	// This parameter is no longer used.
	PricingPlanDataSource *string `json:"pricingPlanDataSource" yaml:"pricingPlanDataSource"`
}

Properties for defining a `CfnGeofenceCollection`.

TODO: EXAMPLE

type CfnMap 

type CfnMap interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrCreateTime() *string
	AttrDataSource() *string
	AttrMapArn() *string
	AttrUpdateTime() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Configuration() interface{}
	SetConfiguration(val interface{})
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	MapName() *string
	SetMapName(val *string)
	Node() awscdk.ConstructNode
	PricingPlan() *string
	SetPricingPlan(val *string)
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Location::Map`.

The `AWS::Location::Map` resource specifies a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.

TODO: EXAMPLE

func NewCfnMap 

func NewCfnMap(scope awscdk.Construct, id *string, props *CfnMapProps) CfnMap

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

type CfnMapProps 

type CfnMapProps struct {
	// Specifies the map style selected from an available data provider.
	Configuration interface{} `json:"configuration" yaml:"configuration"`
	// The name for the map resource.
	//
	// Requirements:
	//
	// - Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
	// - Must be a unique map resource name.
	// - No spaces allowed. For example, `ExampleMap` .
	MapName *string `json:"mapName" yaml:"mapName"`
	// An optional description for the map resource.
	Description *string `json:"description" yaml:"description"`
	// No longer used. If included, the only allowed value is `RequestBasedUsage` .
	//
	// *Allowed Values* : `RequestBasedUsage`
	PricingPlan *string `json:"pricingPlan" yaml:"pricingPlan"`
}

Properties for defining a `CfnMap`.

TODO: EXAMPLE

type CfnMap_MapConfigurationProperty 

type CfnMap_MapConfigurationProperty struct {
	// Specifies the map style selected from an available data provider.
	//
	// Valid styles: `VectorEsriStreets` , `VectorEsriTopographic` , `VectorEsriNavigation` , `VectorEsriDarkGrayCanvas` , `VectorEsriLightGrayCanvas` , `VectorHereBerlin` .
	//
	// > When using HERE as your data provider, and selecting the Style `VectorHereBerlin` , you may not use HERE Technologies maps for Asset Management. See the [AWS Service Terms](https://docs.aws.amazon.com/service-terms/) for Amazon Location Service.
	Style *string `json:"style" yaml:"style"`
}

Specifies the map tile style selected from an available provider.

TODO: EXAMPLE

type CfnPlaceIndex 

type CfnPlaceIndex interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrCreateTime() *string
	AttrIndexArn() *string
	AttrUpdateTime() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DataSource() *string
	SetDataSource(val *string)
	DataSourceConfiguration() interface{}
	SetDataSourceConfiguration(val interface{})
	Description() *string
	SetDescription(val *string)
	IndexName() *string
	SetIndexName(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	PricingPlan() *string
	SetPricingPlan(val *string)
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Location::PlaceIndex`.

The `AWS::Location::PlaceIndex` resource specifies a place index resource in your AWS account, which supports Places functions with geospatial data sourced from your chosen data provider.

TODO: EXAMPLE

func NewCfnPlaceIndex 

func NewCfnPlaceIndex(scope awscdk.Construct, id *string, props *CfnPlaceIndexProps) CfnPlaceIndex

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

type CfnPlaceIndexProps 

type CfnPlaceIndexProps struct {
	// Specifies the data provider of geospatial data.
	//
	// > This field is case-sensitive. Enter the valid values as shown. For example, entering `HERE` will return an error.
	//
	// Valid values include:
	//
	// - `Esri`
	// - `Here`
	//
	// > Place index resources using HERE as a data provider can't be used to [store](https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html) results for locations in Japan. For more information, see the [AWS Service Terms](https://docs.aws.amazon.com/service-terms/) for Amazon Location Service.
	//
	// For additional details on data providers, see the [Amazon Location Service data providers page](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) .
	DataSource *string `json:"dataSource" yaml:"dataSource"`
	// The name of the place index resource.
	//
	// Requirements:
	//
	// - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
	// - Must be a unique place index resource name.
	// - No spaces allowed. For example, `ExamplePlaceIndex` .
	IndexName *string `json:"indexName" yaml:"indexName"`
	// Specifies the data storage option for requesting Places.
	DataSourceConfiguration interface{} `json:"dataSourceConfiguration" yaml:"dataSourceConfiguration"`
	// The optional description for the place index resource.
	Description *string `json:"description" yaml:"description"`
	// No longer used. If included, the only allowed value is `RequestBasedUsage` .
	//
	// *Allowed Values* : `RequestBasedUsage`
	PricingPlan *string `json:"pricingPlan" yaml:"pricingPlan"`
}

Properties for defining a `CfnPlaceIndex`.

TODO: EXAMPLE

type CfnPlaceIndex_DataSourceConfigurationProperty 

type CfnPlaceIndex_DataSourceConfigurationProperty struct {
	// Specifies how the results of an operation will be stored by the caller.
	//
	// Valid values include:
	//
	// - `SingleUse` specifies that the results won't be stored.
	// - `Storage` specifies that the result can be cached or stored in a database.
	//
	// > Place index resources using HERE as a data provider can't be configured to store results for locations in Japan when choosing `Storage` for the `IntendedUse` parameter.
	//
	// Default value: `SingleUse`
	IntendedUse *string `json:"intendedUse" yaml:"intendedUse"`
}

Specifies the data storage option for requesting Places.

TODO: EXAMPLE

type CfnRouteCalculator 

type CfnRouteCalculator interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrCalculatorArn() *string
	AttrCreateTime() *string
	AttrUpdateTime() *string
	CalculatorName() *string
	SetCalculatorName(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DataSource() *string
	SetDataSource(val *string)
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	PricingPlan() *string
	SetPricingPlan(val *string)
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Location::RouteCalculator`.

The `AWS::Location::RouteCalculator` resource specifies a route calculator resource in your AWS account.

You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.

TODO: EXAMPLE

func NewCfnRouteCalculator 

func NewCfnRouteCalculator(scope awscdk.Construct, id *string, props *CfnRouteCalculatorProps) CfnRouteCalculator

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

type CfnRouteCalculatorProps 

type CfnRouteCalculatorProps struct {
	// The name of the route calculator resource.
	//
	// Requirements:
	//
	// - Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
	// - Must be a unique route calculator resource name.
	// - No spaces allowed. For example, `ExampleRouteCalculator` .
	CalculatorName *string `json:"calculatorName" yaml:"calculatorName"`
	// Specifies the data provider of traffic and road network data.
	//
	// > This field is case-sensitive. Enter the valid values as shown. For example, entering `HERE` returns an error.
	//
	// Valid values include:
	//
	// - `Esri`
	// - `Here`
	//
	// For more information about data providers, see the [Amazon Location Service data providers page](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) .
	DataSource *string `json:"dataSource" yaml:"dataSource"`
	// The optional description for the route calculator resource.
	Description *string `json:"description" yaml:"description"`
	// No longer used. If included, the only allowed value is `RequestBasedUsage` .
	//
	// *Allowed Values* : `RequestBasedUsage`
	PricingPlan *string `json:"pricingPlan" yaml:"pricingPlan"`
}

Properties for defining a `CfnRouteCalculator`.

TODO: EXAMPLE

type CfnTracker 

type CfnTracker interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrCreateTime() *string
	AttrTrackerArn() *string
	AttrUpdateTime() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	KmsKeyId() *string
	SetKmsKeyId(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	PositionFiltering() *string
	SetPositionFiltering(val *string)
	PricingPlan() *string
	SetPricingPlan(val *string)
	PricingPlanDataSource() *string
	SetPricingPlanDataSource(val *string)
	Ref() *string
	Stack() awscdk.Stack
	TrackerName() *string
	SetTrackerName(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Location::Tracker`.

The `AWS::Location::Tracker` resource specifies a tracker resource in your AWS account , which lets you receive current and historical location of devices.

TODO: EXAMPLE

func NewCfnTracker 

func NewCfnTracker(scope awscdk.Construct, id *string, props *CfnTrackerProps) CfnTracker

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

type CfnTrackerConsumer 

type CfnTrackerConsumer interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ConsumerArn() *string
	SetConsumerArn(val *string)
	CreationStack() *[]*string
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	TrackerName() *string
	SetTrackerName(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

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.

TODO: EXAMPLE

func NewCfnTrackerConsumer 

func NewCfnTrackerConsumer(scope awscdk.Construct, id *string, props *CfnTrackerConsumerProps) CfnTrackerConsumer

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

type CfnTrackerConsumerProps 

type CfnTrackerConsumerProps struct {
	// 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`
	ConsumerArn *string `json:"consumerArn" yaml:"consumerArn"`
	// 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` .
	TrackerName *string `json:"trackerName" yaml:"trackerName"`
}

Properties for defining a `CfnTrackerConsumer`.

TODO: EXAMPLE

type CfnTrackerProps 

type CfnTrackerProps struct {
	// 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` .
	TrackerName *string `json:"trackerName" yaml:"trackerName"`
	// An optional description for the tracker resource.
	Description *string `json:"description" yaml:"description"`
	// A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) . Enter a key ID, key ARN, alias name, or alias ARN.
	KmsKeyId *string `json:"kmsKeyId" yaml:"kmsKeyId"`
	// Specifies the position filtering for the tracker resource.
	//
	// 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` .
	PositionFiltering *string `json:"positionFiltering" yaml:"positionFiltering"`
	// No longer used.
	//
	// If included, the only allowed value is `RequestBasedUsage` .
	PricingPlan *string `json:"pricingPlan" yaml:"pricingPlan"`
	// This parameter is no longer used.
	PricingPlanDataSource *string `json:"pricingPlanDataSource" yaml:"pricingPlanDataSource"`
}

Properties for defining a `CfnTracker`.

TODO: EXAMPLE

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.