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.
Example
ts
new location.PlaceIndex(this, 'PlaceIndex', {
placeIndexName: 'MyPlaceIndex', // optional, defaults to a generated name
dataSource: location.DataSource.HERE, // optional, defaults to Esri
});
python
location.PlaceIndex(self, "PlaceIndex",
place_index_name="MyPlaceIndex", # optional, defaults to a generated name
data_source=location.DataSource.HERE
)
java
PlaceIndex.Builder.create(this, "PlaceIndex")
.placeIndexName("MyPlaceIndex") // optional, defaults to a generated name
.dataSource(DataSource.HERE)
.build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Location.Alpha
new PlaceIndex(this, "PlaceIndex", new PlaceIndexProps {
PlaceIndexName = "MyPlaceIndex", // optional, defaults to a generated name
DataSource = DataSource.HERE
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdklocationalpha/v2
location.NewPlaceIndex(this, jsii.String("PlaceIndex"), &PlaceIndexProps{
PlaceIndexName: jsii.String("MyPlaceIndex"),
// optional, defaults to a generated name
DataSource: location.DataSource_HERE,
})
Properties
dataSourceoptionalDataSourcedata_sourceoptionalDataSourcedataSourceoptionalDataSourceDataSourceoptionalDataSourceDataSourceoptionalDataSource= DataSource.ESRI#Data source for the place index.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A description for the place index.
Default: no description
intendedUseoptionalIntendedUseintended_useoptionalIntendedUseintendedUseoptionalIntendedUseIntendedUseoptionalIntendedUseIntendedUseoptionalIntendedUse= IntendedUse.SINGLE_USE#Intend use for the results of an operation.
placeIndexNameoptionalstringplace_index_nameoptionalstrplaceIndexNameoptionalStringPlaceIndexNameoptionalstringPlaceIndexNameoptional*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.