Class ModifyGlobalClusterRequest

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

  • Method Details

    • globalClusterIdentifier

      public final String globalClusterIdentifier()

      The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive.

      Constraints: Must match the identifier of an existing global database cluster.

      Returns:
      The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive.

      Constraints: Must match the identifier of an existing global database cluster.

    • newGlobalClusterIdentifier

      public final String newGlobalClusterIdentifier()

      A new cluster identifier to assign to the global database. This value is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens.

      • The first character must be a letter.

      • Can't end with a hyphen or contain two consecutive hyphens

      Example: my-cluster2

      Returns:
      A new cluster identifier to assign to the global database. This value is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens.

      • The first character must be a letter.

      • Can't end with a hyphen or contain two consecutive hyphens

      Example: my-cluster2

    • deletionProtection

      public final Boolean deletionProtection()

      Indicates whether the global database has deletion protection enabled. The global database cannot be deleted when deletion protection is enabled.

      Returns:
      Indicates whether the global database has deletion protection enabled. The global database cannot be deleted when deletion protection is enabled.

    • engineVersion

      public final String engineVersion()

      The version number of the database engine to which you want to upgrade. Changing this parameter will result in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

      To list all of the available Neptune engine versions, use the following command:

      Returns:
      The version number of the database engine to which you want to upgrade. Changing this parameter will result in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

      To list all of the available Neptune engine versions, use the following command:

    • allowMajorVersionUpgrade

      public final Boolean allowMajorVersionUpgrade()

      A value that indicates whether major version upgrades are allowed.

      Constraints: You must allow major version upgrades if you specify a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

      If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version, so you will need to apply any custom parameter groups after completing the upgrade.

      Returns:
      A value that indicates whether major version upgrades are allowed.

      Constraints: You must allow major version upgrades if you specify a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

      If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version, so you will need to apply any custom parameter groups after completing the upgrade.

    • toBuilder

      public ModifyGlobalClusterRequest.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<ModifyGlobalClusterRequest.Builder,ModifyGlobalClusterRequest>
      Specified by:
      toBuilder in class NeptuneRequest
      Returns:
      a builder for type T

    • builder

      public static ModifyGlobalClusterRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModifyGlobalClusterRequest.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.