Class ModifyCustomDbEngineVersionResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ModifyCustomDbEngineVersionResponse.Builder,
ModifyCustomDbEngineVersionResponse>
This data type is used as a response element in the action DescribeDBEngineVersions
.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
The creation time of the DB engine version.final String
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV).final String
The name of the Amazon S3 bucket that contains your database installation files.final String
The Amazon S3 directory that contains the database installation files.final String
The description of the database engine.final String
A value that indicates the source media provider of the AMI based on the usage operation.final String
The ARN of the custom engine version.final String
The description of the database engine version.final String
The name of the DB parameter group family for the database engine.final CharacterSet
The default character set for new instances of this engine version, if theCharacterSetName
parameter of the CreateDBInstance API isn't specified.final String
engine()
The name of the database engine.final String
The version number of the database engine.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.The types of logs that the database engine has available for export to CloudWatch Logs.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the ExportableLogTypes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SupportedCACertificateIdentifiers property.final boolean
For responses, this returns true if the service returned a value for the SupportedCharacterSets property.final boolean
For responses, this returns true if the service returned a value for the SupportedEngineModes property.final boolean
For responses, this returns true if the service returned a value for the SupportedFeatureNames property.final boolean
For responses, this returns true if the service returned a value for the SupportedNcharCharacterSets property.final boolean
For responses, this returns true if the service returned a value for the SupportedTimezones property.final boolean
For responses, this returns true if the service returned a value for the TagList property.final boolean
For responses, this returns true if the service returned a value for the ValidUpgradeTarget property.final CustomDBEngineVersionAMI
image()
The EC2 imagefinal String
kmsKeyId()
The Amazon Web Services KMS key identifier for an encrypted CEV.final String
The major engine version of the CEV.static Class
<? extends ModifyCustomDbEngineVersionResponse.Builder> final String
status()
The status of the DB engine version, eitheravailable
ordeprecated
.A list of the supported CA certificate identifiers.final List
<CharacterSet> A list of the character sets supported by this engine for theCharacterSetName
parameter of theCreateDBInstance
operation.A list of the supported DB engine modes.A list of features supported by the DB engine.final List
<CharacterSet> A list of the character sets supported by the Oracle DB engine for theNcharCharacterSetName
parameter of theCreateDBInstance
operation.A list of the time zones supported by this engine for theTimezone
parameter of theCreateDBInstance
action.final Boolean
Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.final Boolean
Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.final Boolean
Indicates whether you can use Aurora global databases with a specific DB engine version.final Boolean
Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.final Boolean
Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster.final Boolean
Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.final Boolean
Indicates whether you can use Aurora parallel query with a specific DB engine version.final Boolean
Indicates whether the database engine version supports read replicas.tagList()
Returns the value of the TagList property for this object.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final List
<UpgradeTarget> A list of engine versions that this database engine version can be upgraded to.Methods inherited from class software.amazon.awssdk.services.rds.model.RdsResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
engine
The name of the database engine.
- Returns:
- The name of the database engine.
-
engineVersion
The version number of the database engine.
- Returns:
- The version number of the database engine.
-
dbParameterGroupFamily
The name of the DB parameter group family for the database engine.
- Returns:
- The name of the DB parameter group family for the database engine.
-
dbEngineDescription
The description of the database engine.
- Returns:
- The description of the database engine.
-
dbEngineVersionDescription
The description of the database engine version.
- Returns:
- The description of the database engine version.
-
defaultCharacterSet
The default character set for new instances of this engine version, if the
CharacterSetName
parameter of the CreateDBInstance API isn't specified.- Returns:
- The default character set for new instances of this engine version, if the
CharacterSetName
parameter of the CreateDBInstance API isn't specified.
-
image
The EC2 image
- Returns:
- The EC2 image
-
dbEngineMediaType
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
- Returns:
- A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
-
hasSupportedCharacterSets
public final boolean hasSupportedCharacterSets()For responses, this returns true if the service returned a value for the SupportedCharacterSets property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
supportedCharacterSets
A list of the character sets supported by this engine for the
CharacterSetName
parameter of theCreateDBInstance
operation.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSupportedCharacterSets()
method.- Returns:
- A list of the character sets supported by this engine for the
CharacterSetName
parameter of theCreateDBInstance
operation.
-
hasSupportedNcharCharacterSets
public final boolean hasSupportedNcharCharacterSets()For responses, this returns true if the service returned a value for the SupportedNcharCharacterSets property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
supportedNcharCharacterSets
A list of the character sets supported by the Oracle DB engine for the
NcharCharacterSetName
parameter of theCreateDBInstance
operation.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSupportedNcharCharacterSets()
method.- Returns:
- A list of the character sets supported by the Oracle DB engine for the
NcharCharacterSetName
parameter of theCreateDBInstance
operation.
-
hasValidUpgradeTarget
public final boolean hasValidUpgradeTarget()For responses, this returns true if the service returned a value for the ValidUpgradeTarget property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
validUpgradeTarget
A list of engine versions that this database engine version can be upgraded to.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasValidUpgradeTarget()
method.- Returns:
- A list of engine versions that this database engine version can be upgraded to.
-
hasSupportedTimezones
public final boolean hasSupportedTimezones()For responses, this returns true if the service returned a value for the SupportedTimezones property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
supportedTimezones
A list of the time zones supported by this engine for the
Timezone
parameter of theCreateDBInstance
action.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSupportedTimezones()
method.- Returns:
- A list of the time zones supported by this engine for the
Timezone
parameter of theCreateDBInstance
action.
-
hasExportableLogTypes
public final boolean hasExportableLogTypes()For responses, this returns true if the service returned a value for the ExportableLogTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
exportableLogTypes
The types of logs that the database engine has available for export to CloudWatch Logs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasExportableLogTypes()
method.- Returns:
- The types of logs that the database engine has available for export to CloudWatch Logs.
-
supportsLogExportsToCloudwatchLogs
Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
- Returns:
- Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
-
supportsReadReplica
Indicates whether the database engine version supports read replicas.
- Returns:
- Indicates whether the database engine version supports read replicas.
-
hasSupportedEngineModes
public final boolean hasSupportedEngineModes()For responses, this returns true if the service returned a value for the SupportedEngineModes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
supportedEngineModes
A list of the supported DB engine modes.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSupportedEngineModes()
method.- Returns:
- A list of the supported DB engine modes.
-
hasSupportedFeatureNames
public final boolean hasSupportedFeatureNames()For responses, this returns true if the service returned a value for the SupportedFeatureNames property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
supportedFeatureNames
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under
SupportedFeatureNames
in the output.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSupportedFeatureNames()
method.- Returns:
- A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under
SupportedFeatureNames
in the output.
-
status
The status of the DB engine version, either
available
ordeprecated
.- Returns:
- The status of the DB engine version, either
available
ordeprecated
.
-
supportsParallelQuery
Indicates whether you can use Aurora parallel query with a specific DB engine version.
- Returns:
- Indicates whether you can use Aurora parallel query with a specific DB engine version.
-
supportsGlobalDatabases
Indicates whether you can use Aurora global databases with a specific DB engine version.
- Returns:
- Indicates whether you can use Aurora global databases with a specific DB engine version.
-
majorEngineVersion
The major engine version of the CEV.
- Returns:
- The major engine version of the CEV.
-
databaseInstallationFilesS3BucketName
The name of the Amazon S3 bucket that contains your database installation files.
- Returns:
- The name of the Amazon S3 bucket that contains your database installation files.
-
databaseInstallationFilesS3Prefix
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
- Returns:
- The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
-
dbEngineVersionArn
The ARN of the custom engine version.
- Returns:
- The ARN of the custom engine version.
-
kmsKeyId
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
- Returns:
- The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
-
createTime
The creation time of the DB engine version.
- Returns:
- The creation time of the DB engine version.
-
hasTagList
public final boolean hasTagList()For responses, this returns true if the service returned a value for the TagList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tagList
Returns the value of the TagList property for this object.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTagList()
method.- Returns:
- The value of the TagList property for this object.
-
supportsBabelfish
Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
- Returns:
- Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
-
customDBEngineVersionManifest
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.
- Returns:
- JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.
-
supportsCertificateRotationWithoutRestart
Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
- Returns:
- Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
-
hasSupportedCACertificateIdentifiers
public final boolean hasSupportedCACertificateIdentifiers()For responses, this returns true if the service returned a value for the SupportedCACertificateIdentifiers property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
supportedCACertificateIdentifiers
A list of the supported CA certificate identifiers.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSupportedCACertificateIdentifiers()
method.- Returns:
- A list of the supported CA certificate identifiers.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
-
supportsLocalWriteForwarding
Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
- Returns:
- Indicates whether the DB engine version supports forwarding write operations from reader DB instances to
the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB
instances.
Valid for: Aurora DB clusters only
-
supportsIntegrations
Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
- Returns:
- Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
-
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 interfaceToCopyableBuilder<ModifyCustomDbEngineVersionResponse.Builder,
ModifyCustomDbEngineVersionResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends ModifyCustomDbEngineVersionResponse.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-