Class ModifyCustomDbEngineVersionResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.rds.model.RdsResponse
-
- software.amazon.awssdk.services.rds.model.ModifyCustomDbEngineVersionResponse
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ModifyCustomDbEngineVersionResponse.Builder,ModifyCustomDbEngineVersionResponse>
@Generated("software.amazon.awssdk:codegen") public final class ModifyCustomDbEngineVersionResponse extends RdsResponse implements ToCopyableBuilder<ModifyCustomDbEngineVersionResponse.Builder,ModifyCustomDbEngineVersionResponse>
This data type is used as a response element in the action
DescribeDBEngineVersions
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ModifyCustomDbEngineVersionResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ModifyCustomDbEngineVersionResponse.Builder
builder()
Instant
createTime()
The creation time of the DB engine version.String
customDBEngineVersionManifest()
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV).String
databaseInstallationFilesS3BucketName()
The name of the Amazon S3 bucket that contains your database installation files.String
databaseInstallationFilesS3Prefix()
The Amazon S3 directory that contains the database installation files.String
dbEngineDescription()
The description of the database engine.String
dbEngineMediaType()
A value that indicates the source media provider of the AMI based on the usage operation.String
dbEngineVersionArn()
The ARN of the custom engine version.String
dbEngineVersionDescription()
The description of the database engine version.String
dbParameterGroupFamily()
The name of the DB parameter group family for the database engine.CharacterSet
defaultCharacterSet()
The default character set for new instances of this engine version, if theCharacterSetName
parameter of the CreateDBInstance API isn't specified.String
engine()
The name of the database engine.String
engineVersion()
The version number of the database engine.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<String>
exportableLogTypes()
The types of logs that the database engine has available for export to CloudWatch Logs.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasExportableLogTypes()
For responses, this returns true if the service returned a value for the ExportableLogTypes property.int
hashCode()
boolean
hasSupportedCACertificateIdentifiers()
For responses, this returns true if the service returned a value for the SupportedCACertificateIdentifiers property.boolean
hasSupportedCharacterSets()
For responses, this returns true if the service returned a value for the SupportedCharacterSets property.boolean
hasSupportedEngineModes()
For responses, this returns true if the service returned a value for the SupportedEngineModes property.boolean
hasSupportedFeatureNames()
For responses, this returns true if the service returned a value for the SupportedFeatureNames property.boolean
hasSupportedNcharCharacterSets()
For responses, this returns true if the service returned a value for the SupportedNcharCharacterSets property.boolean
hasSupportedTimezones()
For responses, this returns true if the service returned a value for the SupportedTimezones property.boolean
hasTagList()
For responses, this returns true if the service returned a value for the TagList property.boolean
hasValidUpgradeTarget()
For responses, this returns true if the service returned a value for the ValidUpgradeTarget property.CustomDBEngineVersionAMI
image()
The EC2 imageString
kmsKeyId()
The Amazon Web Services KMS key identifier for an encrypted CEV.String
majorEngineVersion()
The major engine version of the CEV.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends ModifyCustomDbEngineVersionResponse.Builder>
serializableBuilderClass()
ServerlessV2FeaturesSupport
serverlessV2FeaturesSupport()
Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions.String
status()
The status of the DB engine version, eitheravailable
ordeprecated
.List<String>
supportedCACertificateIdentifiers()
A list of the supported CA certificate identifiers.List<CharacterSet>
supportedCharacterSets()
A list of the character sets supported by this engine for theCharacterSetName
parameter of theCreateDBInstance
operation.List<String>
supportedEngineModes()
A list of the supported DB engine modes.List<String>
supportedFeatureNames()
A list of features supported by the DB engine.List<CharacterSet>
supportedNcharCharacterSets()
A list of the character sets supported by the Oracle DB engine for theNcharCharacterSetName
parameter of theCreateDBInstance
operation.List<Timezone>
supportedTimezones()
A list of the time zones supported by this engine for theTimezone
parameter of theCreateDBInstance
action.Boolean
supportsBabelfish()
Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.Boolean
supportsCertificateRotationWithoutRestart()
Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.Boolean
supportsGlobalDatabases()
Indicates whether you can use Aurora global databases with a specific DB engine version.Boolean
supportsIntegrations()
Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.Boolean
supportsLimitlessDatabase()
Indicates whether the DB engine version supports Aurora Limitless Database.Boolean
supportsLocalWriteForwarding()
Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster.Boolean
supportsLogExportsToCloudwatchLogs()
Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.Boolean
supportsParallelQuery()
Indicates whether you can use Aurora parallel query with a specific DB engine version.Boolean
supportsReadReplica()
Indicates whether the database engine version supports read replicas.List<Tag>
tagList()
Returns the value of the TagList property for this object.ModifyCustomDbEngineVersionResponse.Builder
toBuilder()
String
toString()
Returns a string representation of this object.List<UpgradeTarget>
validUpgradeTarget()
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 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 name of the database engine.
- Returns:
- The name of the database engine.
-
engineVersion
public final String engineVersion()
The version number of the database engine.
- Returns:
- The version number of the database engine.
-
dbParameterGroupFamily
public final String 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
public final String dbEngineDescription()
The description of the database engine.
- Returns:
- The description of the database engine.
-
dbEngineVersionDescription
public final String dbEngineVersionDescription()
The description of the database engine version.
- Returns:
- The description of the database engine version.
-
defaultCharacterSet
public final CharacterSet 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
public final CustomDBEngineVersionAMI image()
The EC2 image
- Returns:
- The EC2 image
-
dbEngineMediaType
public final String 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
public final List<CharacterSet> 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
public final List<CharacterSet> 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
public final List<UpgradeTarget> 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
public final List<Timezone> 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
public final List<String> 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
public final Boolean 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
public final Boolean 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
public final List<String> 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
public final List<String> 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
public final String status()
The status of the DB engine version, either
available
ordeprecated
.- Returns:
- The status of the DB engine version, either
available
ordeprecated
.
-
supportsParallelQuery
public final Boolean 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
public final Boolean 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
public final String majorEngineVersion()
The major engine version of the CEV.
- Returns:
- The major engine version of the CEV.
-
databaseInstallationFilesS3BucketName
public final String 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
public final String 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
public final String dbEngineVersionArn()
The ARN of the custom engine version.
- Returns:
- The ARN of the custom engine version.
-
kmsKeyId
public final String 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
public final Instant 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
public final List<Tag> 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
public final Boolean supportsBabelfish()
Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
- Returns:
- Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
-
customDBEngineVersionManifest
public final String 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.
-
supportsLimitlessDatabase
public final Boolean supportsLimitlessDatabase()
Indicates whether the DB engine version supports Aurora Limitless Database.
- Returns:
- Indicates whether the DB engine version supports Aurora Limitless Database.
-
supportsCertificateRotationWithoutRestart
public final Boolean 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
public final List<String> 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
public final Boolean 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
public final Boolean 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.
-
serverlessV2FeaturesSupport
public final ServerlessV2FeaturesSupport serverlessV2FeaturesSupport()
Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.
- Returns:
- Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.
-
toBuilder
public ModifyCustomDbEngineVersionResponse.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ModifyCustomDbEngineVersionResponse.Builder,ModifyCustomDbEngineVersionResponse>
- Specified by:
toBuilder
in classAwsResponse
-
builder
public static ModifyCustomDbEngineVersionResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModifyCustomDbEngineVersionResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkResponse
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-