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

Interface CreateKeyRequest.Builder

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

  • Method Details

    • keyName

      CreateKeyRequest.Builder keyName(String keyName)

      A custom name for the API key resource.

      Requirements:

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

      • Must be a unique API key name.

      • No spaces allowed. For example, ExampleAPIKey.

      Parameters:
      keyName - A custom name for the API key resource.

      Requirements:

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

      • Must be a unique API key name.

      • No spaces allowed. For example, ExampleAPIKey.

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

    • restrictions

      CreateKeyRequest.Builder restrictions(ApiKeyRestrictions restrictions)

      The API key restrictions for the API key resource.

      Parameters:
      restrictions - The API key restrictions for the API key resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • restrictions

      default CreateKeyRequest.Builder restrictions(Consumer<ApiKeyRestrictions.Builder> restrictions)

      The API key restrictions for the API key resource.

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

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

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

    • description

      CreateKeyRequest.Builder description(String description)

      An optional description for the API key resource.

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

    • expireTime

      CreateKeyRequest.Builder expireTime(Instant expireTime)

      The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.

      Parameters:
      expireTime - The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • noExpiry

      CreateKeyRequest.Builder noExpiry(Boolean noExpiry)

      Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.

      Parameters:
      noExpiry - Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

      Applies one or more tags to the map resource. A tag is a key-value pair that 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 that 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

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

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