Package software.amazon.awssdk.services.location.model

Interface CreateMapRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateMapRequest.Builder,CreateMapRequest>, LocationRequest.Builder, SdkBuilder<CreateMapRequest.Builder,CreateMapRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateMapRequest
public static interface CreateMapRequest.Builder extends LocationRequest.Builder, SdkPojo, CopyableBuilder<CreateMapRequest.Builder,CreateMapRequest>

  • Method Details

    • configuration

      CreateMapRequest.Builder configuration(MapConfiguration configuration)

      Specifies the MapConfiguration, including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.

      Parameters:
      configuration - Specifies the MapConfiguration, including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      default CreateMapRequest.Builder configuration(Consumer<MapConfiguration.Builder> configuration)

      Specifies the MapConfiguration, including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.

      This is a convenience method that creates an instance of the MapConfiguration.Builder avoiding the need to create one manually via MapConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configuration(MapConfiguration).

      Parameters:
      configuration - a consumer that will call methods on MapConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      CreateMapRequest.Builder description(String description)

      An optional description for the map resource.

      Parameters:
      description - An optional description for the map resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mapName

      CreateMapRequest.Builder mapName(String mapName)

      The name for the map resource.

      Requirements:

      • Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

      • Must be a unique map resource name.

      • No spaces allowed. For example, ExampleMap.

      Parameters:
      mapName - The name for the map resource.

      Requirements:

      • Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

      • Must be a unique map resource name.

      • No spaces allowed. For example, ExampleMap.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pricingPlan

      @Deprecated CreateMapRequest.Builder pricingPlan(String pricingPlan)
      Deprecated.
      Deprecated. If included, the only allowed value is RequestBasedUsage.

      No longer used. If included, the only allowed value is RequestBasedUsage.

      Parameters:
      pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pricingPlan

      @Deprecated CreateMapRequest.Builder pricingPlan(PricingPlan pricingPlan)
      Deprecated.
      Deprecated. If included, the only allowed value is RequestBasedUsage.

      No longer used. If included, the only allowed value is RequestBasedUsage.

      Parameters:
      pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateMapRequest.Builder tags(Map<String,String> tags)

      Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

      Format: "key" : "value"

      Restrictions:

      • Maximum 50 tags per resource

      • Each resource tag must be unique with a maximum of one value.

      • Maximum key length: 128 Unicode characters in UTF-8

      • Maximum value length: 256 Unicode characters in UTF-8

      • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

      • Cannot use "aws:" as a prefix for a key.

      Parameters:
      tags - Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

      Format: "key" : "value"

      Restrictions:

      • Maximum 50 tags per resource

      • Each resource tag must be unique with a maximum of one value.

      • Maximum key length: 128 Unicode characters in UTF-8

      • Maximum value length: 256 Unicode characters in UTF-8

      • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

      • Cannot use "aws:" as a prefix for a key.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateMapRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateMapRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.