Class UpdateClusterRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.dsql.model.DsqlRequest
software.amazon.awssdk.services.dsql.model.UpdateClusterRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateClusterRequest extends DsqlRequest implements ToCopyableBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>

  • Method Details

    • identifier

      public final String identifier()

      The ID of the cluster you want to update.

      Returns:
      The ID of the cluster you want to update.

    • deletionProtectionEnabled

      public final Boolean deletionProtectionEnabled()

      Specifies whether to enable deletion protection in your cluster.

      Returns:
      Specifies whether to enable deletion protection in your cluster.

    • kmsEncryptionKey

      public final String kmsEncryptionKey()

      The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.

      Returns:
      The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

      If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

      If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

    • multiRegionProperties

      public final MultiRegionProperties multiRegionProperties()

      The new multi-Region cluster configuration settings to be applied during an update operation.

      Returns:
      The new multi-Region cluster configuration settings to be applied during an update operation.

    • toBuilder

      public UpdateClusterRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>
      Specified by:
      toBuilder in class DsqlRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateClusterRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateClusterRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.