Package software.amazon.awssdk.services.rds.model

Class ModifyCustomDbEngineVersionRequest

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

  • Method Details

    • engine

      public final String engine()

      The database engine. RDS Custom for Oracle supports the following values:

      • custom-oracle-ee

      • custom-oracle-ee-cdb

      • custom-oracle-se2

      • custom-oracle-se2-cdb

      Returns:
      The database engine. RDS Custom for Oracle supports the following values:

      • custom-oracle-ee

      • custom-oracle-ee-cdb

      • custom-oracle-se2

      • custom-oracle-se2-cdb

    • engineVersion

      public final String engineVersion()

      The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.

      Returns:
      The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.

    • description

      public final String description()

      An optional description of your CEV.

      Returns:
      An optional description of your CEV.

    • status

      public final CustomEngineVersionStatus status()

      The availability status to be assigned to the CEV. Valid values are as follows:

      available

      You can use this CEV to create a new RDS Custom DB instance.

      inactive

      You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.

      You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.

      If the service returns an enum value that is not available in the current SDK version, status will return CustomEngineVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The availability status to be assigned to the CEV. Valid values are as follows:

      available

      You can use this CEV to create a new RDS Custom DB instance.

      inactive

      You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.

      You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.

      See Also:

    • statusAsString

      public final String statusAsString()

      The availability status to be assigned to the CEV. Valid values are as follows:

      available

      You can use this CEV to create a new RDS Custom DB instance.

      inactive

      You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.

      You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.

      If the service returns an enum value that is not available in the current SDK version, status will return CustomEngineVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The availability status to be assigned to the CEV. Valid values are as follows:

      available

      You can use this CEV to create a new RDS Custom DB instance.

      inactive

      You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.

      You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.

      See Also:

    • toBuilder

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

    • builder

      public static ModifyCustomDbEngineVersionRequest.Builder builder()

    • serializableBuilderClass

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