Class CfnPlaceIndex

A CloudFormation AWS::Location::PlaceIndex.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnPlaceIndex

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.Location

Assembly: Amazon.CDK.AWS.Location.dll

Syntax (csharp)

public class CfnPlaceIndex : CfnResource, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnPlaceIndex
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable

Remarks

Specifies a place index resource in your AWS account. Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.

If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the AWS service terms for more details.

CloudformationResource: AWS::Location::PlaceIndex

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;

var cfnPlaceIndex = new CfnPlaceIndex(this, "MyCfnPlaceIndex", new CfnPlaceIndexProps {
    DataSource = "dataSource",
    IndexName = "indexName",

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

Synopsis

Constructors

CfnPlaceIndex(Construct, String, ICfnPlaceIndexProps)	Create a new `AWS::Location::PlaceIndex`.
CfnPlaceIndex(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnPlaceIndex(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrArn	The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .
AttrCreateTime	The timestamp for when the place index resource was created in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ` .
AttrIndexArn	Synonym for `Arn` .
AttrUpdateTime	The timestamp for when the place index resource was last updated in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ` .
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
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` .

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnPlaceIndex(Construct, String, ICfnPlaceIndexProps)

Create a new AWS::Location::PlaceIndex.

public CfnPlaceIndex(Construct scope, string id, ICfnPlaceIndexProps props)

Parameters

scope Construct

scope in which this resource is defined.

id System.String

scoped id of the resource.

props ICfnPlaceIndexProps

resource properties.

CfnPlaceIndex(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnPlaceIndex(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnPlaceIndex(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnPlaceIndex(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Properties

AttrArn

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

public virtual string AttrArn { get; }

Property Value

System.String

Remarks

CloudformationAttribute: Arn

AttrCreateTime

The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

public virtual string AttrCreateTime { get; }

Property Value

System.String

Remarks

CloudformationAttribute: CreateTime

AttrIndexArn

Synonym for Arn .

public virtual string AttrIndexArn { get; }

Property Value

System.String

Remarks

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

CloudformationAttribute: IndexArn

AttrUpdateTime

The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

public virtual string AttrUpdateTime { get; }

Property Value

System.String

Remarks

CloudformationAttribute: UpdateTime

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

DataSource

Specifies the geospatial data provider for the new place index.

public virtual string DataSource { get; set; }

Property Value

System.String

Remarks

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE 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 .

Link: 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 virtual object DataSourceConfiguration { get; set; }

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.

public virtual string Description { get; set; }

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.

public virtual string IndexName { get; set; }

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 .

public virtual string PricingPlan { get; set; }

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable