software.amazon.awscdk.services.location

Class CfnPlaceIndex

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.location.CfnPlaceIndex

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:38.428Z")
public class CfnPlaceIndex
extends CfnResource
implements IInspectable

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

Specifies a place index resource in your AWS account. Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.

If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the AWS service terms for more details.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.location.*;
 CfnPlaceIndex cfnPlaceIndex = CfnPlaceIndex.Builder.create(this, "MyCfnPlaceIndex")
         .dataSource("dataSource")
         .indexName("indexName")
         // the properties below are optional
         .dataSourceConfiguration(DataSourceConfigurationProperty.builder()
                 .intendedUse("intendedUse")
                 .build())
         .description("description")
         .pricingPlan("pricingPlan")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnPlaceIndex.Builder A fluent builder for CfnPlaceIndex.
static interface	CfnPlaceIndex.DataSourceConfigurationProperty Specifies the data storage option requesting Places.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPlaceIndex(Construct scope, java.lang.String id, CfnPlaceIndexProps props) Create a new `AWS::Location::PlaceIndex`.
protected	CfnPlaceIndex(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPlaceIndex(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) for the place index resource.
java.lang.String	getAttrCreateTime() The timestamp for when the place index resource was created in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .
java.lang.String	getAttrIndexArn() Synonym for `Arn` .
java.lang.String	getAttrUpdateTime() The timestamp for when the place index resource was last updated in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDataSource() Specifies the geospatial data provider for the new place index.
java.lang.Object	getDataSourceConfiguration() Specifies the data storage option requesting Places.
java.lang.String	getDescription() The optional description for the place index resource.
java.lang.String	getIndexName() The name of the place index resource.
java.lang.String	getPricingPlan() No longer used.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDataSource(java.lang.String value) Specifies the geospatial data provider for the new place index.
void	setDataSourceConfiguration(CfnPlaceIndex.DataSourceConfigurationProperty value) Specifies the data storage option requesting Places.
void	setDataSourceConfiguration(IResolvable value) Specifies the data storage option requesting Places.
void	setDescription(java.lang.String value) The optional description for the place index resource.
void	setIndexName(java.lang.String value) The name of the place index resource.
void	setPricingPlan(java.lang.String value) No longer used.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPlaceIndex

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

CfnPlaceIndex

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

CfnPlaceIndex

public CfnPlaceIndex(Construct scope,
                     java.lang.String id,
                     CfnPlaceIndexProps props)

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

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

• Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

getAttrCreateTime

public java.lang.String getAttrCreateTime()

The timestamp for when the place index resource was created in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .

getAttrIndexArn

public java.lang.String getAttrIndexArn()

Synonym for `Arn` .

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

• Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

getAttrUpdateTime

public java.lang.String getAttrUpdateTime()

The timestamp for when the place index resource was last updated in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDataSource

public java.lang.String getDataSource()

Specifies the geospatial data provider for the new place index.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

• Esri – For additional information about Esri 's coverage in your region of interest, see Esri details on geocoding coverage .
• Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps ' coverage, see GrabMaps countries and areas covered .
• Here – For additional information about HERE Technologies ' coverage in your region of interest, see HERE details on goecoding coverage .

If you specify HERE Technologies ( Here ) as the data provider, you may not store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service Developer Guide .

setDataSource

public void setDataSource(java.lang.String value)

Specifies the geospatial data provider for the new place index.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

• Esri – For additional information about Esri 's coverage in your region of interest, see Esri details on geocoding coverage .
• Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps ' coverage, see GrabMaps countries and areas covered .
• Here – For additional information about HERE Technologies ' coverage in your region of interest, see HERE details on goecoding coverage .

If you specify HERE Technologies ( Here ) as the data provider, you may not store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service Developer Guide .

getIndexName

public java.lang.String getIndexName()

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 .

setIndexName

public void setIndexName(java.lang.String value)

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 .

getDataSourceConfiguration

public java.lang.Object getDataSourceConfiguration()

Specifies the data storage option requesting Places.

setDataSourceConfiguration

public void setDataSourceConfiguration(IResolvable value)

Specifies the data storage option requesting Places.

setDataSourceConfiguration

public void setDataSourceConfiguration(CfnPlaceIndex.DataSourceConfigurationProperty value)

Specifies the data storage option requesting Places.

getDescription

public java.lang.String getDescription()

The optional description for the place index resource.

setDescription

public void setDescription(java.lang.String value)

The optional description for the place index resource.

getPricingPlan

public java.lang.String getPricingPlan()

No longer used. If included, the only allowed value is `RequestBasedUsage` .

Allowed Values : RequestBasedUsage

setPricingPlan

public void setPricingPlan(java.lang.String value)

No longer used. If included, the only allowed value is `RequestBasedUsage` .

Allowed Values : RequestBasedUsage