Interface UpdateKeyRequest.Builder

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

  • Method Details

    • keyName

      UpdateKeyRequest.Builder keyName(String keyName)

      The name of the API key resource to update.

      Parameters:
      keyName - The name of the API key resource to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      UpdateKeyRequest.Builder description(String description)

      Updates the description for the API key resource.

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

    • expireTime

      UpdateKeyRequest.Builder expireTime(Instant expireTime)

      Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

      Parameters:
      expireTime - Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • noExpiry

      UpdateKeyRequest.Builder noExpiry(Boolean noExpiry)

      Whether the API key should expire. Set to true to set the API key to have no expiration time.

      Parameters:
      noExpiry - Whether the API key should expire. Set to true to set the API key to have no expiration time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • forceUpdate

      UpdateKeyRequest.Builder forceUpdate(Boolean forceUpdate)

      The boolean flag to be included for updating ExpireTime or Restrictions details.

      Must be set to true to update an API key resource that has been used in the past 7 days.

      False if force update is not preferred

      Default value: False

      Parameters:
      forceUpdate - The boolean flag to be included for updating ExpireTime or Restrictions details.

      Must be set to true to update an API key resource that has been used in the past 7 days.

      False if force update is not preferred

      Default value: False

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

    • restrictions

      UpdateKeyRequest.Builder restrictions(ApiKeyRestrictions restrictions)

      Updates the API key restrictions for the API key resource.

      Parameters:
      restrictions - Updates 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 UpdateKeyRequest.Builder restrictions(Consumer<ApiKeyRestrictions.Builder> restrictions)

      Updates 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:

    • overrideConfiguration

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

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