@aws-cdk/aws-location-alpha.PlaceIndexProps

Experimental

@aws-cdk/aws-location-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

PlaceIndexProps Struct

Properties for a place index.

PlaceIndexProps

used as props by

• PlaceIndex

Stability

Experimental

Source

lib/place-index.ts

Example

new location.PlaceIndex(this, 'PlaceIndex', {
  placeIndexName: 'MyPlaceIndex', // optional, defaults to a generated name
  dataSource: location.DataSource.HERE, // optional, defaults to Esri
});

Properties

dataSource?optionalDataSourcedata_source?optionalDataSourcedataSource?optionalDataSourceDataSource?optionalDataSourceDataSource?optionalDataSource= DataSource.ESRI#

Data source for the place index.

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

A description for the place index.

Default: no description

intendedUse?optionalIntendedUseintended_use?optionalIntendedUseintendedUse?optionalIntendedUseIntendedUse?optionalIntendedUseIntendedUse?optionalIntendedUse= IntendedUse.SINGLE_USE#

Intend use for the results of an operation.

placeIndexName?optionalstringplace_index_name?optionalstrplaceIndexName?optionalStringPlaceIndexName?optionalstringPlaceIndexName?optional*string#

A name for the place index.

Default: A name is automatically generated

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