Class CfnPlaceIndex

Specifies a place index resource in your AWS account.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnPlaceIndex
Inherited Members
Namespace: Amazon.CDK.AWS.Location
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnPlaceIndex : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnPlaceIndex
    Inherits CfnResource
    Implements IInspectable, ITaggableV2
Remarks

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.

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

CloudformationResource: AWS::Location::PlaceIndex

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",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

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
CfnPlaceIndex(Construct, String, ICfnPlaceIndexProps)

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 .
CdkTagManager

Tag Manager which manages the tags for this resource.
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.
Tags

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

Methods

Inspect(TreeInspector)

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

Constructors

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

CfnPlaceIndex(Construct, String, ICfnPlaceIndexProps)

public CfnPlaceIndex(Construct scope, string id, ICfnPlaceIndexProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnPlaceIndexProps

Resource properties.

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

      CdkTagManager

      Tag Manager which manages the tags for this resource.

      public virtual TagManager CdkTagManager { get; }
      Property Value

      TagManager

      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

      DataSource

      Specifies the geospatial data provider for the new place index.

      public virtual string DataSource { get; set; }
      Property Value

      System.String

      DataSourceConfiguration

      Specifies the data storage option requesting Places.

      public virtual object DataSourceConfiguration { get; set; }
      Property Value

      System.Object

      Description

      The optional description for the place index resource.

      public virtual string Description { get; set; }
      Property Value

      System.String

      IndexName

      The name of the place index resource.

      public virtual string IndexName { get; set; }
      Property Value

      System.String

      PricingPlan

      No longer used.

      public virtual string PricingPlan { get; set; }
      Property Value

      System.String

      Remarks

      If included, the only allowed value is RequestBasedUsage .

      Tags

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

      public virtual ICfnTag[] Tags { get; set; }
      Property Value

      ICfnTag[]

      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

      Implements