Package software.amazon.awscdk.services.location

Interface CfnPlaceIndexProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPlaceIndexProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:32.222Z")
@Stability(Stable)
public interface CfnPlaceIndexProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPlaceIndex.

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.*;
 CfnPlaceIndexProps cfnPlaceIndexProps = CfnPlaceIndexProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPlaceIndexProps.Builder	A builder for CfnPlaceIndexProps
static final class	CfnPlaceIndexProps.Jsii$Proxy	An implementation for CfnPlaceIndexProps

Method Summary

Modifier and Type	Method	Description
static CfnPlaceIndexProps.Builder	builder()
String	getDataSource()	Specifies the geospatial data provider for the new place index.
default Object	getDataSourceConfiguration()	Specifies the data storage option requesting Places.
default String	getDescription()	The optional description for the place index resource.
String	getIndexName()	The name of the place index resource.
default String	getPricingPlan()	No longer used.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataSource

@Stability(Stable)
@NotNull
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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-datasource

getIndexName

@Stability(Stable)
@NotNull
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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-indexname

getDataSourceConfiguration

@Stability(Stable)
@Nullable
default Object getDataSourceConfiguration()

Specifies the data storage option requesting Places.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-datasourceconfiguration

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The optional description for the place index resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-description

getPricingPlan

@Stability(Stable)
@Nullable
default String getPricingPlan()

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

Allowed Values : RequestBasedUsage

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-pricingplan

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-tags

builder

@Stability(Stable)
static CfnPlaceIndexProps.Builder builder()

Returns:

a CfnPlaceIndexProps.Builder of CfnPlaceIndexProps