Package software.amazon.awscdk.services.location.alpha

Class PlaceIndex.Builder

java.lang.Object

software.amazon.awscdk.services.location.alpha.PlaceIndex.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PlaceIndex>

Enclosing class:

PlaceIndex

@Stability(Experimental)
public static final class PlaceIndex.Builder
extends Object
implements software.amazon.jsii.Builder<PlaceIndex>

(experimental) A fluent builder for PlaceIndex.

Method Summary

Modifier and Type	Method	Description
PlaceIndex	build()
static PlaceIndex.Builder	create(software.constructs.Construct scope, String id)
PlaceIndex.Builder	dataSource(DataSource dataSource)	(experimental) Data source for the place index.
PlaceIndex.Builder	description(String description)	(experimental) A description for the place index.
PlaceIndex.Builder	intendedUse(IntendedUse intendedUse)	(experimental) Intend use for the results of an operation.
PlaceIndex.Builder	placeIndexName(String placeIndexName)	(experimental) A name for the place index.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Experimental)
public static PlaceIndex.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of PlaceIndex.Builder.

dataSource

@Stability(Experimental)
public PlaceIndex.Builder dataSource(DataSource dataSource)

(experimental) Data source for the place index.

Default: DataSource.ESRI

Parameters:

dataSource - Data source for the place index. This parameter is required.

Returns:

this

description

@Stability(Experimental)
public PlaceIndex.Builder description(String description)

(experimental) A description for the place index.

Default: - no description

Parameters:

description - A description for the place index. This parameter is required.

Returns:

this

intendedUse

@Stability(Experimental)
public PlaceIndex.Builder intendedUse(IntendedUse intendedUse)

(experimental) Intend use for the results of an operation.

Default: IntendedUse.SINGLE_USE

Parameters:

intendedUse - Intend use for the results of an operation. This parameter is required.

Returns:

this

placeIndexName

@Stability(Experimental)
public PlaceIndex.Builder placeIndexName(String placeIndexName)

(experimental) A name for the place index.

Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores.

Default: - A name is automatically generated

Parameters:

placeIndexName - A name for the place index. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public PlaceIndex build()

Specified by:

build in interface software.amazon.jsii.Builder<PlaceIndex>

Returns:

a newly built instance of PlaceIndex.