Interface DeleteKeyRequest.Builder

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

  • Method Details

    • keyName

      DeleteKeyRequest.Builder keyName(String keyName)

      The name of the API key to delete.

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

    • forceDelete

      DeleteKeyRequest.Builder forceDelete(Boolean forceDelete)

      ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

      Valid values: true, or false.

      Required: No

      This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

      Parameters:
      forceDelete - ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

      Valid values: true, or false.

      Required: No

      This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

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

    • overrideConfiguration

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

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