awscdklocationalpha

README

AWS::Location Construct Library

---

The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.

---

This module is part of the AWS Cloud Development Kit project.

Amazon Location Service lets you add location data and functionality to applications, which includes capabilities such as maps, points of interest, geocoding, routing, geofences, and tracking. Amazon Location provides location-based services (LBS) using high-quality data from global, trusted providers Esri and HERE. With affordable data, tracking and geofencing capabilities, and built-in metrics for health monitoring, you can build sophisticated location-enabled applications.

Place Index

A key function of Amazon Location Service is the ability to search the geolocation information. Amazon Location provides this functionality via the Place index resource. The place index includes which data provider to use for the search.

To create a place index, define a PlaceIndex:

location.NewPlaceIndex(this, jsii.String("PlaceIndex"), &PlaceIndexProps{
	PlaceIndexName: jsii.String("MyPlaceIndex"),
	 // optional, defaults to a generated name
	DataSource: location.DataSource_HERE,
})

Use the grant() or grantSearch() method to grant the given identity permissions to perform actions on the place index:

var role role


placeIndex := location.NewPlaceIndex(this, jsii.String("PlaceIndex"))
placeIndex.grantSearch(role)

Documentation

Overview

The CDK Construct Library for AWS::Location

Index

• func NewPlaceIndex_Override(p PlaceIndex, scope constructs.Construct, id *string, props *PlaceIndexProps)
• func PlaceIndex_IsConstruct(x interface{}) *bool
• func PlaceIndex_IsOwnedResource(construct constructs.IConstruct) *bool
• func PlaceIndex_IsResource(construct constructs.IConstruct) *bool
• type DataSource
• type IPlaceIndex
  • func PlaceIndex_FromPlaceIndexArn(scope constructs.Construct, id *string, placeIndexArn *string) IPlaceIndex
  • func PlaceIndex_FromPlaceIndexName(scope constructs.Construct, id *string, placeIndexName *string) IPlaceIndex
• type IntendedUse
• type PlaceIndex
  • func NewPlaceIndex(scope constructs.Construct, id *string, props *PlaceIndexProps) PlaceIndex
• type PlaceIndexProps

Functions

func NewPlaceIndex_Override

func NewPlaceIndex_Override(p PlaceIndex, scope constructs.Construct, id *string, props *PlaceIndexProps)

Experimental.

func PlaceIndex_IsConstruct

func PlaceIndex_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

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.

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

func PlaceIndex_IsOwnedResource

func PlaceIndex_IsOwnedResource(construct constructs.IConstruct) *bool

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

func PlaceIndex_IsResource

func PlaceIndex_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

Types

type DataSource

type DataSource string

Data source for a place index.

Example:

location.NewPlaceIndex(this, jsii.String("PlaceIndex"), &PlaceIndexProps{
	PlaceIndexName: jsii.String("MyPlaceIndex"),
	 // optional, defaults to a generated name
	DataSource: location.DataSource_HERE,
})

Experimental.

const (
	// Esri.
	// See: https://docs.aws.amazon.com/location/latest/developerguide/esri.html
	//
	// Experimental.
	DataSource_ESRI DataSource = "ESRI"
	// HERE.
	// See: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
	//
	// Experimental.
	DataSource_HERE DataSource = "HERE"
)

type IPlaceIndex

type IPlaceIndex interface {
	awscdk.IResource
	// The Amazon Resource Name (ARN) of the place index resource.
	// Experimental.
	PlaceIndexArn() *string
	// The name of the place index.
	// Experimental.
	PlaceIndexName() *string
}

A Place Index. Experimental.

func PlaceIndex_FromPlaceIndexArn

func PlaceIndex_FromPlaceIndexArn(scope constructs.Construct, id *string, placeIndexArn *string) IPlaceIndex

Use an existing place index by ARN. Experimental.

func PlaceIndex_FromPlaceIndexName

func PlaceIndex_FromPlaceIndexName(scope constructs.Construct, id *string, placeIndexName *string) IPlaceIndex

Use an existing place index by name. Experimental.

type IntendedUse

type IntendedUse string

Intend use for the results of an operation. Experimental.

const (
	// The results won't be stored.
	// Experimental.
	IntendedUse_SINGLE_USE IntendedUse = "SINGLE_USE"
	// The result can be cached or stored in a database.
	// Experimental.
	IntendedUse_STORAGE IntendedUse = "STORAGE"
)

type PlaceIndex

type PlaceIndex interface {
	awscdk.Resource
	IPlaceIndex
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	// Experimental.
	Env() *awscdk.ResourceEnvironment
	// The tree node.
	// Experimental.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//   cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	// The Amazon Resource Name (ARN) of the place index resource.
	// Experimental.
	PlaceIndexArn() *string
	// The timestamp for when the place index resource was created in ISO 8601 forma.
	// Experimental.
	PlaceIndexCreateTime() *string
	// The name of the place index.
	// Experimental.
	PlaceIndexName() *string
	// The timestamp for when the place index resource was last updated in ISO 8601 format.
	// Experimental.
	PlaceIndexUpdateTime() *string
	// The stack in which this resource is defined.
	// Experimental.
	Stack() awscdk.Stack
	// Apply the given removal policy to this resource.
	//
	// 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`).
	// Experimental.
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	// Experimental.
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	// Experimental.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	// Experimental.
	GetResourceNameAttribute(nameAttr *string) *string
	// Grant the given principal identity permissions to perform the actions on this place index.
	// Experimental.
	Grant(grantee awsiam.IGrantable, actions ...*string) awsiam.Grant
	// Grant the given identity permissions to search using this index.
	// Experimental.
	GrantSearch(grantee awsiam.IGrantable) awsiam.Grant
	// Returns a string representation of this construct.
	// Experimental.
	ToString() *string
}

A Place Index.

Example:

location.NewPlaceIndex(this, jsii.String("PlaceIndex"), &PlaceIndexProps{
	PlaceIndexName: jsii.String("MyPlaceIndex"),
	 // optional, defaults to a generated name
	DataSource: location.DataSource_HERE,
})

See: https://docs.aws.amazon.com/location/latest/developerguide/places-concepts.html

Experimental.

func NewPlaceIndex

func NewPlaceIndex(scope constructs.Construct, id *string, props *PlaceIndexProps) PlaceIndex

Experimental.

type PlaceIndexProps

type PlaceIndexProps struct {
	// Data source for the place index.
	// Experimental.
	DataSource DataSource `field:"optional" json:"dataSource" yaml:"dataSource"`
	// A description for the place index.
	// Experimental.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// Intend use for the results of an operation.
	// Experimental.
	IntendedUse IntendedUse `field:"optional" json:"intendedUse" yaml:"intendedUse"`
	// A name for the place index.
	// Experimental.
	PlaceIndexName *string `field:"optional" json:"placeIndexName" yaml:"placeIndexName"`
}

Properties for a place index.

Example:

location.NewPlaceIndex(this, jsii.String("PlaceIndex"), &PlaceIndexProps{
	PlaceIndexName: jsii.String("MyPlaceIndex"),
	 // optional, defaults to a generated name
	DataSource: location.DataSource_HERE,
})

Experimental.