software.amazon.awscdk.services.location

Class CfnPlaceIndex.Builder

java.lang.Object

software.amazon.awscdk.services.location.CfnPlaceIndex.Builder

Enclosing class:

CfnPlaceIndex

public static final class CfnPlaceIndex.Builder
extends java.lang.Object

A fluent builder for CfnPlaceIndex.

Method Summary

Modifier and Type	Method and Description
CfnPlaceIndex	build()
static CfnPlaceIndex.Builder	create(Construct scope, java.lang.String id)
CfnPlaceIndex.Builder	dataSource(java.lang.String dataSource) Specifies the data provider of geospatial data.
CfnPlaceIndex.Builder	dataSourceConfiguration(CfnPlaceIndex.DataSourceConfigurationProperty dataSourceConfiguration) Specifies the data storage option for requesting Places.
CfnPlaceIndex.Builder	dataSourceConfiguration(IResolvable dataSourceConfiguration) Specifies the data storage option for requesting Places.
CfnPlaceIndex.Builder	description(java.lang.String description) The optional description for the place index resource.
CfnPlaceIndex.Builder	indexName(java.lang.String indexName) The name of the place index resource.
CfnPlaceIndex.Builder	pricingPlan(java.lang.String pricingPlan) No longer used.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CfnPlaceIndex.Builder create(Construct scope,
                                           java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnPlaceIndex.DataSourceConfigurationProperty.Builder.

dataSource

public CfnPlaceIndex.Builder dataSource(java.lang.String dataSource)

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 .

Parameters:

dataSource - Specifies the data provider of geospatial data. This parameter is required.

Returns:

this

indexName

public CfnPlaceIndex.Builder indexName(java.lang.String indexName)

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 .

Parameters:

indexName - The name of the place index resource. This parameter is required.

Returns:

this

dataSourceConfiguration

public CfnPlaceIndex.Builder dataSourceConfiguration(IResolvable dataSourceConfiguration)

Specifies the data storage option for requesting Places.

Parameters:

dataSourceConfiguration - Specifies the data storage option for requesting Places. This parameter is required.

Returns:

this

dataSourceConfiguration

public CfnPlaceIndex.Builder dataSourceConfiguration(CfnPlaceIndex.DataSourceConfigurationProperty dataSourceConfiguration)

Specifies the data storage option for requesting Places.

Parameters:

dataSourceConfiguration - Specifies the data storage option for requesting Places. This parameter is required.

Returns:

this

description

public CfnPlaceIndex.Builder description(java.lang.String description)

The optional description for the place index resource.

Parameters:

description - The optional description for the place index resource. This parameter is required.

Returns:

this

pricingPlan

public CfnPlaceIndex.Builder pricingPlan(java.lang.String pricingPlan)

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

Allowed Values : RequestBasedUsage

Parameters:

pricingPlan - No longer used. If included, the only allowed value is `RequestBasedUsage` . This parameter is required.

Returns:

this

build

public CfnPlaceIndex build()