CfnPlaceIndexProps

class aws_cdk.aws_location.CfnPlaceIndexProps(*, data_source, index_name, data_source_configuration=None, description=None, pricing_plan=None, tags=None)

Bases: object

Properties for defining a CfnPlaceIndex.

Parameters:

data_source (str) – Specifies the geospatial data provider for the new place index. .. epigraph:: 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 . .. epigraph:: 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 .
index_name (str) – 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 .
data_source_configuration (Union[IResolvable, DataSourceConfigurationProperty, Dict[str, Any], None]) – Specifies the data storage option requesting Places.
description (Optional[str]) – The optional description for the place index resource.
pricing_plan (Optional[str]) – No longer used. If included, the only allowed value is RequestBasedUsage . Allowed Values : RequestBasedUsage
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_location as location

cfn_place_index_props = location.CfnPlaceIndexProps(
    data_source="dataSource",
    index_name="indexName",

    # the properties below are optional
    data_source_configuration=location.CfnPlaceIndex.DataSourceConfigurationProperty(
        intended_use="intendedUse"
    ),
    description="description",
    pricing_plan="pricingPlan",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

data_source

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-datasource

data_source_configuration

Specifies the data storage option requesting Places.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-datasourceconfiguration

description

The optional description for the place index resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-description

index_name

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-indexname

pricing_plan

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

Allowed Values : RequestBasedUsage

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-pricingplan

tags

An array of key-value pairs to apply to this resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-placeindex.html#cfn-location-placeindex-tags