AWS CDK Reference

Appearance

v2.274.0

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.

Stability
Experimental
Source
lib/place-index.ts

Example ​

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

Properties ​

dataSourceDataSourcedata_sourceDataSourcedataSourceDataSourceDataSourceDataSourceDataSourceDataSource= DataSource.ESRI#
Data source for the place index.
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#
A description for the place index.

Default: no description

intendedUseIntendedUseintended_useIntendedUseintendedUseIntendedUseIntendedUseIntendedUseIntendedUseIntendedUse= IntendedUse.SINGLE_USE#
Intend use for the results of an operation.
placeIndexNamestringplace_index_namestrplaceIndexNameStringPlaceIndexNamestringPlaceIndexName*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.