Package software.amazon.awscdk.services.location

Class CfnPlaceIndex.Builder

java.lang.Object
software.amazon.awscdk.services.location.CfnPlaceIndex.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnPlaceIndex>
Enclosing class:
CfnPlaceIndex
@Stability(Stable) public static final class CfnPlaceIndex.Builder extends Object implements software.amazon.jsii.Builder<CfnPlaceIndex>
A fluent builder for CfnPlaceIndex.

  • Method Details

    • create

      @Stability(Stable) public static CfnPlaceIndex.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnPlaceIndex.Builder.

    • dataSource

      @Stability(Stable) public CfnPlaceIndex.Builder dataSource(String dataSource)
      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 .

      Parameters:
      dataSource - Specifies the geospatial data provider for the new place index. This parameter is required.
      Returns:
      this

    • indexName

      @Stability(Stable) public CfnPlaceIndex.Builder indexName(String indexName)
      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 .

      Parameters:
      indexName - The name of the place index resource. This parameter is required.
      Returns:
      this

    • dataSourceConfiguration

      @Stability(Stable) public CfnPlaceIndex.Builder dataSourceConfiguration(IResolvable dataSourceConfiguration)
      Specifies the data storage option requesting Places.

      Parameters:
      dataSourceConfiguration - Specifies the data storage option requesting Places. This parameter is required.
      Returns:
      this

    • dataSourceConfiguration

      @Stability(Stable) public CfnPlaceIndex.Builder dataSourceConfiguration(CfnPlaceIndex.DataSourceConfigurationProperty dataSourceConfiguration)
      Specifies the data storage option requesting Places.

      Parameters:
      dataSourceConfiguration - Specifies the data storage option requesting Places. This parameter is required.
      Returns:
      this

    • description

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

      Parameters:
      description - The optional description for the place index resource. This parameter is required.
      Returns:
      this

    • pricingPlan

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

      Allowed Values : RequestBasedUsage

      Parameters:
      pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage . This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnPlaceIndex build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnPlaceIndex>
      Returns:
      a newly built instance of CfnPlaceIndex.