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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.687Z")
 @Stability(value=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")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnPlaceIndexProps.Builder	builder()
String	getDataSource() Specifies the data provider of geospatial data.
default Object	getDataSourceConfiguration() Specifies the data storage option for 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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDataSource

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

getIndexName

@Stability(value=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 .

getDataSourceConfiguration

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

Specifies the data storage option for requesting Places.

getDescription

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

The optional description for the place index resource.

getPricingPlan

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

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

Allowed Values : RequestBasedUsage

builder

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

Returns:

a CfnPlaceIndexProps.Builder of CfnPlaceIndexProps