software.amazon.awscdk.services.location

Class CfnPlaceIndex

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.location.CfnPlaceIndex

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.675Z")
 @Stability(value=Stable)
public class CfnPlaceIndex
extends CfnResource
implements IInspectable

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

The AWS::Location::PlaceIndex resource specifies a place index resource in your AWS account, which supports Places functions with geospatial data sourced from your chosen data provider.

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 for requesting Places.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPlaceIndex(software.constructs.Construct scope, 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
String	getAttrArn() The Amazon Resource Name (ARN) for the place index resource.
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` .
String	getAttrIndexArn() Synonym for `Arn` .
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 Map<String,Object>	getCfnProperties()
String	getDataSource() Specifies the data provider of geospatial data.
Object	getDataSourceConfiguration() Specifies the data storage option for requesting Places.
String	getDescription() The optional description for the place index resource.
String	getIndexName() The name of the place index resource.
String	getPricingPlan() No longer used.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDataSource(String value) Specifies the data provider of geospatial data.
void	setDataSourceConfiguration(CfnPlaceIndex.DataSourceConfigurationProperty value) Specifies the data storage option for requesting Places.
void	setDataSourceConfiguration(IResolvable value) Specifies the data storage option for requesting Places.
void	setDescription(String value) The optional description for the place index resource.
void	setIndexName(String value) The name of the place index resource.
void	setPricingPlan(String value) No longer used.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnPlaceIndex(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDataSource

@Stability(value=Stable)
 @NotNull
public String getDataSource()

Specifies the data provider of geospatial data.

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

Valid values include:

• Esri
• Here

Place index resources using HERE as a data provider can't be used to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional details on data providers, see the Amazon Location Service data providers page .

setDataSource

@Stability(value=Stable)
public void setDataSource(@NotNull
                                                   String value)

Specifies the data provider of geospatial data.

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

Valid values include:

• Esri
• Here

Place index resources using HERE as a data provider can't be used to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional details on data providers, see the Amazon Location Service data providers page .

getIndexName

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setIndexName(@NotNull
                                                  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

@Stability(value=Stable)
 @Nullable
public Object getDataSourceConfiguration()

Specifies the data storage option for requesting Places.

setDataSourceConfiguration

@Stability(value=Stable)
public void setDataSourceConfiguration(@Nullable
                                                                CfnPlaceIndex.DataSourceConfigurationProperty value)

Specifies the data storage option for requesting Places.

setDataSourceConfiguration

@Stability(value=Stable)
public void setDataSourceConfiguration(@Nullable
                                                                IResolvable value)

Specifies the data storage option for requesting Places.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The optional description for the place index resource.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The optional description for the place index resource.

getPricingPlan

@Stability(value=Stable)
 @Nullable
public String getPricingPlan()

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

Allowed Values : RequestBasedUsage

setPricingPlan

@Stability(value=Stable)
public void setPricingPlan(@Nullable
                                                    String value)

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

Allowed Values : RequestBasedUsage