@aws-cdk_aws-location-alpha.IPlaceIndex

interface IPlaceIndex ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Location.Alpha.IPlaceIndex
Gogithub.com/aws/aws-cdk-go/awscdklocationalpha/v2#IPlaceIndex
Javasoftware.amazon.awscdk.services.location.alpha.IPlaceIndex
Pythonaws_cdk.aws_location_alpha.IPlaceIndex
TypeScript (source)@aws-cdk/aws-location-alpha ยป IPlaceIndex

Implemented by PlaceIndex

Obtainable from PlaceIndex.fromPlaceIndexArn(), PlaceIndex.fromPlaceIndexName()

A Place Index.

Properties

NameTypeDescription
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
placeIndexArn๐Ÿ”นstringThe Amazon Resource Name (ARN) of the place index resource.
placeIndexName๐Ÿ”นstringThe name of the place index.
stack๐Ÿ”นStackThe stack in which this resource is defined.

env๐Ÿ”น

Type: ResourceEnvironment

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.


node๐Ÿ”น

Type: Node

The tree node.


placeIndexArn๐Ÿ”น

Type: string

The Amazon Resource Name (ARN) of the place index resource.


placeIndexName๐Ÿ”น

Type: string

The name of the place index.


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.

applyRemovalPolicy(policy)๐Ÿ”น

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

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).