Class CfnPlaceIndexProps

Properties for defining a CfnPlaceIndex.

Inheritance

object

CfnPlaceIndexProps

Implements

ICfnPlaceIndexProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Location

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnPlaceIndexProps : ICfnPlaceIndexProps

Syntax (vb)

Public Class CfnPlaceIndexProps Implements ICfnPlaceIndexProps

Remarks

See: 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;

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

                 // the properties below are optional
                 DataSourceConfiguration = new DataSourceConfigurationProperty {
                     IntendedUse = "intendedUse"
                 },
                 Description = "description",
                 PricingPlan = "pricingPlan",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnPlaceIndexProps()

Properties for defining a CfnPlaceIndex.

Properties

DataSource	Specifies the geospatial data provider for the new place index.
DataSourceConfiguration	Specifies the data storage option 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` .
Tags	An array of key-value pairs to apply to this resource.

Constructors

CfnPlaceIndexProps()

Properties for defining a CfnPlaceIndex.

public CfnPlaceIndexProps()

Remarks

See: 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;

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

                 // the properties below are optional
                 DataSourceConfiguration = new DataSourceConfigurationProperty {
                     IntendedUse = "intendedUse"
                 },
                 Description = "description",
                 PricingPlan = "pricingPlan",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

DataSource

Specifies the geospatial data provider for the new place index.

public string DataSource { get; set; }

Property Value

string

Remarks

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

Valid values include:

If you specify HERE Technologies ( <code>Here</code> ) as the data provider, you may not <a href="https://docs.aws.amazon.com//location-places/latest/APIReference/API_DataSourceConfiguration.html">store results</a> 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 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

DataSourceConfiguration

Specifies the data storage option requesting Places.

public object? DataSourceConfiguration { get; set; }

Property Value

object

Remarks

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.

public string? Description { get; set; }

Property Value

string

Remarks

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

public string IndexName { get; set; }

Property Value

string

Remarks

Requirements:

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

public string? PricingPlan { get; set; }

Property Value

string

Remarks

Allowed Values : RequestBasedUsage

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

Implements

ICfnPlaceIndexProps