Interface ICfnPlaceIndexProps

Properties for defining a CfnPlaceIndex.

Namespace: Amazon.CDK.AWS.Location

Assembly: Amazon.CDK.AWS.Location.dll

Syntax (csharp)

public interface ICfnPlaceIndexProps

Syntax (vb)

Public Interface ICfnPlaceIndexProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Location;

CfnPlaceIndexProps cfnPlaceIndexProps = new CfnPlaceIndexProps {
    DataSource = "dataSource",
    IndexName = "indexName",

    // the properties below are optional
    DataSourceConfiguration = new DataSourceConfigurationProperty {
        IntendedUse = "intendedUse"
    },
    Description = "description",
    PricingPlan = "pricingPlan"
};

Synopsis

Properties

DataSource	Specifies the data provider of geospatial data.
DataSourceConfiguration	Specifies the data storage option for requesting Places.
Description	The optional description for the place index resource.
IndexName	The name of the place index resource.
PricingPlan	No longer used. If included, the only allowed value is RequestBasedUsage .

Properties

DataSource

Specifies the data provider of geospatial data.

string DataSource { get; }

Property Value

System.String

Remarks

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

Valid values include:

Place index resources using HERE as a data provider can&apos;t be used to <a href="https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html">store</a> results for locations in Japan. For more information, see the <a href="https://docs.aws.amazon.com/service-terms/">AWS Service Terms</a> for Amazon Location Service.

For additional details on data providers, see the Amazon Location Service data providers page .

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

DataSourceConfiguration

Specifies the data storage option for requesting Places.

virtual object DataSourceConfiguration { get; }

Property Value

System.Object

Remarks

Link: 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.

virtual string Description { get; }

Property Value

System.String

Remarks

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

IndexName

The name of the place index resource.

string IndexName { get; }

Property Value

System.String

Remarks

Requirements:

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

PricingPlan

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

virtual string PricingPlan { get; }

Property Value

System.String

Remarks

Allowed Values : RequestBasedUsage

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