Package software.amazon.awscdk.services.location

Class CfnPlaceIndex

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.location.CfnPlaceIndex
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:59.790Z") @Stability(Stable) public class CfnPlaceIndex extends CfnResource implements IInspectable
A CloudFormation AWS::Location::PlaceIndex.

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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.location.*;
 CfnPlaceIndex cfnPlaceIndex = CfnPlaceIndex.Builder.create(this, "MyCfnPlaceIndex")
         .dataSource("dataSource")
         .indexName("indexName")
         // the properties below are optional
         .dataSourceConfiguration(DataSourceConfigurationProperty.builder()
                 .intendedUse("intendedUse")
                 .build())
         .description("description")
         .pricingPlan("pricingPlan")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPlaceIndex

      protected CfnPlaceIndex(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPlaceIndex

      protected CfnPlaceIndex(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPlaceIndex

      @Stability(Stable) public CfnPlaceIndex(@NotNull Construct scope, @NotNull String id, @NotNull CfnPlaceIndexProps props)
      Create a new AWS::Location::PlaceIndex.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS .

      • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

    • getAttrCreateTime

      @Stability(Stable) @NotNull public String getAttrCreateTime()
      The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • getAttrIndexArn

      @Stability(Stable) @NotNull public String getAttrIndexArn()
      Synonym for Arn .

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

      • Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

    • getAttrUpdateTime

      @Stability(Stable) @NotNull public String getAttrUpdateTime()
      The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDataSource

      @Stability(Stable) @NotNull public String getDataSource()
      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:

      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 .

    • setDataSource

      @Stability(Stable) public void setDataSource(@NotNull String value)
      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:

      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 .

    • getIndexName

      @Stability(Stable) @NotNull public String getIndexName()
      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 .

    • setIndexName

      @Stability(Stable) public void setIndexName(@NotNull String value)
      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 .

    • getDataSourceConfiguration

      @Stability(Stable) @Nullable public Object getDataSourceConfiguration()
      Specifies the data storage option requesting Places.

    • setDataSourceConfiguration

      @Stability(Stable) public void setDataSourceConfiguration(@Nullable IResolvable value)
      Specifies the data storage option requesting Places.

    • setDataSourceConfiguration

      @Stability(Stable) public void setDataSourceConfiguration(@Nullable CfnPlaceIndex.DataSourceConfigurationProperty value)
      Specifies the data storage option requesting Places.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The optional description for the place index resource.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The optional description for the place index resource.

    • getPricingPlan

      @Stability(Stable) @Nullable public String getPricingPlan()
      No longer used. If included, the only allowed value is RequestBasedUsage .

      Allowed Values : RequestBasedUsage

    • setPricingPlan

      @Stability(Stable) public void setPricingPlan(@Nullable String value)
      No longer used. If included, the only allowed value is RequestBasedUsage .

      Allowed Values : RequestBasedUsage