Experimental

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

PlaceIndex L2 construct

A Place Index.

Stability: Experimental
Source: lib/place-index.ts

Example

new location.PlaceIndex(this, 'PlaceIndex', {
  placeIndexName: 'MyPlaceIndex', // optional, defaults to a generated name
  dataSource: location.DataSource.HERE, // optional, defaults to Esri
});

python

location.PlaceIndex(self, "PlaceIndex",
    place_index_name="MyPlaceIndex",  # optional, defaults to a generated name
    data_source=location.DataSource.HERE
)

java

PlaceIndex.Builder.create(this, "PlaceIndex")
        .placeIndexName("MyPlaceIndex") // optional, defaults to a generated name
        .dataSource(DataSource.HERE)
        .build();

csharp

// Install: dotnet add package Amazon.CDK.AWS.Location.Alpha
new PlaceIndex(this, "PlaceIndex", new PlaceIndexProps {
    PlaceIndexName = "MyPlaceIndex",  // optional, defaults to a generated name
    DataSource = DataSource.HERE
});

// Install: go get github.com/aws/aws-cdk-go/awscdklocationalpha/v2
location.NewPlaceIndex(this, jsii.String("PlaceIndex"), &PlaceIndexProps{
	PlaceIndexName: jsii.String("MyPlaceIndex"),
	 // optional, defaults to a generated name
	DataSource: location.DataSource_HERE,
})

Initializer

new PlaceIndex(scope: Construct, id: string, props?: PlaceIndexProps)

python

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

java

new PlaceIndex(Construct scope, String id, PlaceIndexProps props)

csharp

new PlaceIndex(Construct scope, string id, PlaceIndexProps? props = null)

NewPlaceIndex(Scope Construct, Id *string, Props PlaceIndexProps)

Construct Props

dataSourceoptionalDataSourcedata_sourceoptionalDataSourcedataSourceoptionalDataSourceDataSourceoptionalDataSourceDataSourceoptionalDataSource= DataSource.ESRI#

Data source for the place index.

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#

A description for the place index.

Default: no description

intendedUseoptionalIntendedUseintended_useoptionalIntendedUseintendedUseoptionalIntendedUseIntendedUseoptionalIntendedUseIntendedUseoptionalIntendedUse= IntendedUse.SINGLE_USE#

Intend use for the results of an operation.

placeIndexNameoptionalstringplace_index_nameoptionalstrplaceIndexNameoptionalStringPlaceIndexNameoptionalstringPlaceIndexNameoptional*string#

A name for the place index.

Default: A name is automatically generated

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

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

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.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

placeIndexArnstringplace_index_arnstrplaceIndexArnStringPlaceIndexArnstringPlaceIndexArn*string#

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

placeIndexCreateTimestringplace_index_create_timestrplaceIndexCreateTimeStringPlaceIndexCreateTimestringPlaceIndexCreateTime*string#

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

placeIndexNamestringplace_index_namestrplaceIndexNameStringPlaceIndexNamestringPlaceIndexName*string#

The name of the place index.

placeIndexUpdateTimestringplace_index_update_timestrplaceIndexUpdateTimeStringPlaceIndexUpdateTimestringPlaceIndexUpdateTime*string#

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

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#

Uniquely identifies this class.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

Methods

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

fromPlaceIndexArn(scope: Construct, id: string, placeIndexArn: string): IPlaceIndex@staticmethod def from_place_index_arn(scope: Construct, id: str, place_index_arn: str) -> IPlaceIndexpublic static IPlaceIndex fromPlaceIndexArn(Construct scope, String id, String placeIndexArn)public static IPlaceIndex FromPlaceIndexArn(Construct scope, string id, string placeIndexArn)func FromPlaceIndexArn(Scope Construct, Id *string, PlaceIndexArn *string) IPlaceIndexstatic#

Use an existing place index by ARN.

fromPlaceIndexName(scope: Construct, id: string, placeIndexName: string): IPlaceIndex@staticmethod def from_place_index_name(scope: Construct, id: str, place_index_name: str) -> IPlaceIndexpublic static IPlaceIndex fromPlaceIndexName(Construct scope, String id, String placeIndexName)public static IPlaceIndex FromPlaceIndexName(Construct scope, string id, string placeIndexName)func FromPlaceIndexName(Scope Construct, Id *string, PlaceIndexName *string) IPlaceIndexstatic#

Use an existing place index 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 place index.

[disable-awslint:no-grants]

grantSearch(grantee: IGrantable): Grantdef grant_search(self, grantee: IGrantable) -> Grantpublic Grant grantSearch(IGrantable grantee)public Grant GrantSearch(IGrantable grantee)func GrantSearch(Grantee IGrantable) Grant#

Grant the given identity permissions to search using this index [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.

PlaceIndex L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​