Class CfnPlaceIndexProps.Builder
java.lang.Object
software.amazon.awscdk.services.location.CfnPlaceIndexProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnPlaceIndexProps>
- Enclosing interface:
CfnPlaceIndexProps
@Stability(Stable)
public static final class CfnPlaceIndexProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPlaceIndexProps>
A builder for
CfnPlaceIndexProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.dataSource
(String dataSource) Sets the value ofCfnPlaceIndexProps.getDataSource()
dataSourceConfiguration
(IResolvable dataSourceConfiguration) Sets the value ofCfnPlaceIndexProps.getDataSourceConfiguration()
dataSourceConfiguration
(CfnPlaceIndex.DataSourceConfigurationProperty dataSourceConfiguration) Sets the value ofCfnPlaceIndexProps.getDataSourceConfiguration()
description
(String description) Sets the value ofCfnPlaceIndexProps.getDescription()
Sets the value ofCfnPlaceIndexProps.getIndexName()
pricingPlan
(String pricingPlan) Sets the value ofCfnPlaceIndexProps.getPricingPlan()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
dataSource
Sets the value ofCfnPlaceIndexProps.getDataSource()
- Parameters:
dataSource
- Specifies the geospatial data provider for the new place index. This parameter is required.This field is case-sensitive. Enter the valid values as shown. For example, entering
HERE
returns an error.Valid values include:
Esri
– For additional information about Esri 's coverage in your region of interest, see Esri details on geocoding coverage .Grab
– Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps ' coverage, see GrabMaps countries and areas covered .Here
– For additional information about HERE Technologies ' coverage in your region of interest, see HERE details on goecoding coverage .
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 .
- Returns:
this
-
indexName
Sets the value ofCfnPlaceIndexProps.getIndexName()
- Parameters:
indexName
- The name of the place index resource. This parameter is required. 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
.
- Returns:
this
-
dataSourceConfiguration
@Stability(Stable) public CfnPlaceIndexProps.Builder dataSourceConfiguration(IResolvable dataSourceConfiguration) Sets the value ofCfnPlaceIndexProps.getDataSourceConfiguration()
- Parameters:
dataSourceConfiguration
- Specifies the data storage option requesting Places.- Returns:
this
-
dataSourceConfiguration
@Stability(Stable) public CfnPlaceIndexProps.Builder dataSourceConfiguration(CfnPlaceIndex.DataSourceConfigurationProperty dataSourceConfiguration) Sets the value ofCfnPlaceIndexProps.getDataSourceConfiguration()
- Parameters:
dataSourceConfiguration
- Specifies the data storage option requesting Places.- Returns:
this
-
description
Sets the value ofCfnPlaceIndexProps.getDescription()
- Parameters:
description
- The optional description for the place index resource.- Returns:
this
-
pricingPlan
Sets the value ofCfnPlaceIndexProps.getPricingPlan()
- Parameters:
pricingPlan
- No longer used. If included, the only allowed value isRequestBasedUsage
. Allowed Values :RequestBasedUsage
- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnPlaceIndexProps>
- Returns:
- a new instance of
CfnPlaceIndexProps
- Throws:
NullPointerException
- if any required attribute was not provided
-