Package software.amazon.awscdk.services.location.alpha

Class PlaceIndex

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.location.alpha.PlaceIndex

All Implemented Interfaces:

IResource, IPlaceIndex, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:15.901Z")
@Stability(Experimental)
public class PlaceIndex
extends Resource
implements IPlaceIndex

(experimental) A Place Index.

Example:

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

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PlaceIndex.Builder	(experimental) A fluent builder for PlaceIndex.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.location.alpha.IPlaceIndex

IPlaceIndex.Jsii$Default, IPlaceIndex.Jsii$Proxy

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

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PlaceIndex(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	PlaceIndex(software.amazon.jsii.JsiiObjectRef objRef)
	PlaceIndex(software.constructs.Construct scope, String id)
	PlaceIndex(software.constructs.Construct scope, String id, PlaceIndexProps props)

Method Summary

Modifier and Type	Method	Description
static IPlaceIndex	fromPlaceIndexArn(software.constructs.Construct scope, String id, String placeIndexArn)	(experimental) Use an existing place index by ARN.
static IPlaceIndex	fromPlaceIndexName(software.constructs.Construct scope, String id, String placeIndexName)	(experimental) Use an existing place index by name.
String	getPlaceIndexArn()	(experimental) The Amazon Resource Name (ARN) of the place index resource.
String	getPlaceIndexCreateTime()	(experimental) The timestamp for when the place index resource was created in ISO 8601 forma.
String	getPlaceIndexName()	(experimental) The name of the place index.
String	getPlaceIndexUpdateTime()	(experimental) The timestamp for when the place index resource was last updated in ISO 8601 format.
Grant	grant(IGrantable grantee, @NotNull String... actions)	(experimental) Grant the given principal identity permissions to perform the actions on this place index.
Grant	grantSearch(IGrantable grantee)	(experimental) Grant the given identity permissions to search using this index.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

PlaceIndex

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

PlaceIndex

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

PlaceIndex

@Stability(Experimental)
public PlaceIndex(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 PlaceIndexProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

PlaceIndex

@Stability(Experimental)
public PlaceIndex(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

fromPlaceIndexArn

@Stability(Experimental)
@NotNull
public static IPlaceIndex fromPlaceIndexArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String placeIndexArn)

(experimental) Use an existing place index by ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

placeIndexArn - This parameter is required.

fromPlaceIndexName

@Stability(Experimental)
@NotNull
public static IPlaceIndex fromPlaceIndexName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String placeIndexName)

(experimental) Use an existing place index by name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

placeIndexName - This parameter is required.

grant

@Stability(Experimental)
@NotNull
public Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 @NotNull String... actions)

(experimental) Grant the given principal identity permissions to perform the actions on this place index.

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantSearch

@Stability(Experimental)
@NotNull
public Grant grantSearch(@NotNull
 IGrantable grantee)

(experimental) Grant the given identity permissions to search using this index.

Parameters:

grantee - This parameter is required.

getPlaceIndexArn

@Stability(Experimental)
@NotNull
public String getPlaceIndexArn()

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

Specified by:

getPlaceIndexArn in interface IPlaceIndex

getPlaceIndexCreateTime

@Stability(Experimental)
@NotNull
public String getPlaceIndexCreateTime()

(experimental) The timestamp for when the place index resource was created in ISO 8601 forma.

getPlaceIndexName

@Stability(Experimental)
@NotNull
public String getPlaceIndexName()

(experimental) The name of the place index.

Specified by:

getPlaceIndexName in interface IPlaceIndex

getPlaceIndexUpdateTime

@Stability(Experimental)
@NotNull
public String getPlaceIndexUpdateTime()

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