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(value="software.amazon.awssdk:codegen")
public final class ModifyCustomDbEngineVersionRequest
extends RdsRequest
implements ToCopyableBuilder<ModifyCustomDbEngineVersionRequest.Builder,ModifyCustomDbEngineVersionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ModifyCustomDbEngineVersionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ModifyCustomDbEngineVersionRequest.Builder	builder()
String	description() An optional description of your CEV.
String	engine() The DB engine.
String	engineVersion() The custom engine version (CEV) that you want to modify.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ModifyCustomDbEngineVersionRequest.Builder>	serializableBuilderClass()
CustomEngineVersionStatus	status() The availability status to be assigned to the CEV.
String	statusAsString() The availability status to be assigned to the CEV.
ModifyCustomDbEngineVersionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

engine

public final String engine()

The DB engine. The only supported values are custom-oracle-ee and custom-oracle-ee-cdb.

Returns:

The DB engine. The only supported values are custom-oracle-ee and custom-oracle-ee-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:

CustomEngineVersionStatus

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:

CustomEngineVersionStatus

toBuilder

public ModifyCustomDbEngineVersionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyCustomDbEngineVersionRequest.Builder,ModifyCustomDbEngineVersionRequest>

Specified by:

toBuilder in class RdsRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo