@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:38.428Z") public class CfnPlaceIndex extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnPlaceIndex(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnPlaceIndex(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnPlaceIndex(Construct scope, java.lang.String id, CfnPlaceIndexProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
public java.lang.String getAttrCreateTime()
public java.lang.String getAttrIndexArn()
The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .
arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
public java.lang.String getAttrUpdateTime()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getDataSource()
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 .
public void setDataSource(java.lang.String value)
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 .
public java.lang.String getIndexName()
Requirements:
ExamplePlaceIndex
.public void setIndexName(java.lang.String value)
Requirements:
ExamplePlaceIndex
.public java.lang.Object getDataSourceConfiguration()
public void setDataSourceConfiguration(IResolvable value)
public void setDataSourceConfiguration(CfnPlaceIndex.DataSourceConfigurationProperty value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getPricingPlan()
Allowed Values : RequestBasedUsage
public void setPricingPlan(java.lang.String value)
Allowed Values : RequestBasedUsage