Class CfnPlaceIndex
- All Implemented Interfaces:
IInspectable
,ITaggableV2
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
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") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnPlaceIndex
.static interface
Specifies the data storage option requesting Places.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.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnPlaceIndex
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnPlaceIndex
(software.amazon.jsii.JsiiObjectRef objRef) CfnPlaceIndex
(software.constructs.Construct scope, String id, CfnPlaceIndexProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) for the place index resource.The timestamp for when the place index resource was created in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ
.Synonym forArn
.The timestamp for when the place index resource was last updated in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ
.Tag Manager which manages the tags for this resource.Specifies the geospatial data provider for the new place index.Specifies the data storage option requesting Places.The optional description for the place index resource.The name of the place index resource.No longer used.getTags()
An array of key-value pairs to apply to this resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDataSource
(String value) Specifies the geospatial data provider for the new place index.void
Specifies the data storage option requesting Places.void
Specifies the data storage option 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.void
An array of key-value pairs to apply to this resource.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnPlaceIndex
protected CfnPlaceIndex(software.amazon.jsii.JsiiObjectRef objRef) -
CfnPlaceIndex
protected CfnPlaceIndex(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnPlaceIndex
@Stability(Stable) public CfnPlaceIndex(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPlaceIndexProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
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
- Format example:
-
getAttrCreateTime
The timestamp for when the place index resource was created in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ
. -
getAttrIndexArn
Synonym forArn
.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
- Format example:
-
getAttrUpdateTime
The timestamp for when the place index resource was last updated in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ
. -
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getDataSource
Specifies the geospatial data provider for the new place index. -
setDataSource
Specifies the geospatial data provider for the new place index. -
getIndexName
The name of the place index resource. -
setIndexName
The name of the place index resource. -
getDataSourceConfiguration
Specifies the data storage option requesting Places. -
setDataSourceConfiguration
Specifies the data storage option requesting Places. -
setDataSourceConfiguration
@Stability(Stable) public void setDataSourceConfiguration(@Nullable CfnPlaceIndex.DataSourceConfigurationProperty value) Specifies the data storage option requesting Places. -
getDescription
The optional description for the place index resource. -
setDescription
The optional description for the place index resource. -
getPricingPlan
No longer used.If included, the only allowed value is
RequestBasedUsage
. -
setPricingPlan
No longer used.If included, the only allowed value is
RequestBasedUsage
. -
getTags
An array of key-value pairs to apply to this resource. -
setTags
An array of key-value pairs to apply to this resource.
-