PlaceIndexProps

class aws_cdk.aws_location_alpha.PlaceIndexProps(*, data_source=None, description=None, intended_use=None, place_index_name=None)

Bases: object

(experimental) Properties for a place index.

Parameters:

data_source (Optional[DataSource]) – (experimental) Data source for the place index. Default: DataSource.ESRI
description (Optional[str]) – (experimental) A description for the place index. Default: - no description
intended_use (Optional[IntendedUse]) – (experimental) Intend use for the results of an operation. Default: IntendedUse.SINGLE_USE
place_index_name (Optional[str]) – (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

Stability:

experimental

ExampleMetadata:

infused

Example:

location.PlaceIndex(self, "PlaceIndex",
    place_index_name="MyPlaceIndex",  # optional, defaults to a generated name
    data_source=location.DataSource.HERE
)

Attributes

data_source

(experimental) Data source for the place index.

Default:: DataSource.ESRI
Stability:: experimental

description

(experimental) A description for the place index.

Default:

no description

Stability:

experimental

intended_use

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

Default:: IntendedUse.SINGLE_USE
Stability:: experimental

place_index_name

(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

Stability:

experimental