interface CfnPlaceIndexProps

Language	Type name
.NET	`Amazon.CDK.AWS.Location.CfnPlaceIndexProps`
Java	`software.amazon.awscdk.services.location.CfnPlaceIndexProps`
Python	`aws_cdk.aws_location.CfnPlaceIndexProps`
TypeScript	`@aws-cdk/aws-location` » `CfnPlaceIndexProps`

Properties for defining a CfnPlaceIndex.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as location from '@aws-cdk/aws-location';
const cfnPlaceIndexProps: location.CfnPlaceIndexProps = {
  dataSource: 'dataSource',
  indexName: 'indexName',

  // the properties below are optional
  dataSourceConfiguration: {
    intendedUse: 'intendedUse',
  },
  description: 'description',
  pricingPlan: 'pricingPlan',
};

Properties

Name	Type	Description
dataSource	`string`	Specifies the geospatial data provider for the new place index.
indexName	`string`	The name of the place index resource.
dataSourceConfiguration?	`IResolvable` `\|` `DataSourceConfigurationProperty`	Specifies the data storage option requesting Places.
description?	`string`	The optional description for the place index resource.
pricingPlan?	`string`	No longer used. If included, the only allowed value is `RequestBasedUsage` .

dataSource

Type: string

Specifies the geospatial data provider for the new place index.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

Esri – For additional information about Esri 's coverage in your region of interest, see Esri details on geocoding coverage .
Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps ' coverage, see GrabMaps countries and areas covered .
Here – For additional information about HERE Technologies ' coverage in your region of interest, see HERE details on goecoding coverage .

If you specify HERE Technologies ( Here ) as the data provider, you may not store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service Developer Guide .

indexName

Type: string

The name of the place index resource.

Requirements:

Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
Must be a unique place index resource name.
No spaces allowed. For example, ExamplePlaceIndex .

dataSourceConfiguration?

Type: IResolvable | DataSourceConfigurationProperty (optional)

Specifies the data storage option requesting Places.

description?

Type: string (optional)

The optional description for the place index resource.

pricingPlan?

Type: string (optional)

No longer used. If included, the only allowed value is RequestBasedUsage .

Allowed Values : RequestBasedUsage