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

Interface PlaceIndexProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PlaceIndexProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:53.466Z")
@Stability(Experimental)
public interface PlaceIndexProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a place index.

Example:

 PlaceIndex.Builder.create(this, "PlaceIndex")
         .placeIndexName("MyPlaceIndex") // optional, defaults to a generated name
         .dataSource(DataSource.HERE)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PlaceIndexProps.Builder	builder()
default DataSource	getDataSource()	(experimental) Data source for the place index.
default String	getDescription()	(experimental) A description for the place index.
default IntendedUse	getIntendedUse()	(experimental) Intend use for the results of an operation.
default String	getPlaceIndexName()	(experimental) A name for the place index.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataSource

@Stability(Experimental)
@Nullable
default DataSource getDataSource()

(experimental) Data source for the place index.

Default: DataSource.ESRI

getDescription

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

(experimental) A description for the place index.

Default: - no description

getIntendedUse

@Stability(Experimental)
@Nullable
default IntendedUse getIntendedUse()

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

Default: IntendedUse.SINGLE_USE

getPlaceIndexName

@Stability(Experimental)
@Nullable
default String getPlaceIndexName()

(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

builder

@Stability(Experimental)
static PlaceIndexProps.Builder builder()

Returns:

a PlaceIndexProps.Builder of PlaceIndexProps