DBEngineVersion (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.rds.model.DBEngineVersion

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DBEngineVersion.Builder,DBEngineVersion>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class DBEngineVersion
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DBEngineVersion.Builder,DBEngineVersion>
```
This data type is used as a response element in the action DescribeDBEngineVersions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DBEngineVersion.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DBEngineVersion.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DBEngineVersion.Builder`	`builder()`
`Instant`	`createTime()` The creation time of the DB engine version.
`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`	`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 the `CharacterSetName` 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)` Indicates whether some other object is "equal to" this one by SDK fields.
`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`	`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.
`String`	`kmsKeyId()` The Amazon Web Services KMS key identifier for an encrypted CEV.
`String`	`majorEngineVersion()` The major engine version of the CEV.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DBEngineVersion.Builder>`	`serializableBuilderClass()`
`String`	`status()` The status of the DB engine version, either `available` or `deprecated`.
`List<CharacterSet>`	`supportedCharacterSets()` A list of the character sets supported by this engine for the `CharacterSetName` parameter of the `CreateDBInstance` 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 the `NcharCharacterSetName` parameter of the `CreateDBInstance` operation.
`List<Timezone>`	`supportedTimezones()` A list of the time zones supported by this engine for the `Timezone` parameter of the `CreateDBInstance` action.
`Boolean`	`supportsGlobalDatabases()` A value that indicates whether you can use Aurora global databases with a specific DB engine version.
`Boolean`	`supportsLogExportsToCloudwatchLogs()` A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
`Boolean`	`supportsParallelQuery()` A value that 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.
`DBEngineVersion.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`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 java.lang.Object
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.
  - 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 the isEmpty() 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 the CreateDBInstance 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 the CreateDBInstance 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 the isEmpty() 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 the CreateDBInstance 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 the CreateDBInstance 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 the isEmpty() 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 the isEmpty() 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 the CreateDBInstance 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 the CreateDBInstance 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 the isEmpty() 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()
```
    A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
    
    Returns:
    
    A value that 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 the isEmpty() 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 the isEmpty() 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 or deprecated.
    
    Returns:
    
    The status of the DB engine version, either available or deprecated.
  - supportsParallelQuery
```
public final Boolean supportsParallelQuery()
```
    A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
    
    Returns:
    
    A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
  - supportsGlobalDatabases
```
public final Boolean supportsGlobalDatabases()
```
    A value that indicates whether you can use Aurora global databases with a specific DB engine version.
    
    Returns:
    
    A value that 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 the isEmpty() 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.
  - toBuilder
```
public DBEngineVersion.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<DBEngineVersion.Builder,DBEngineVersion>
    
    Returns:
    
    a builder for type T
  - builder
```
public static DBEngineVersion.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DBEngineVersion.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - 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.

AWS SDK for Java API Reference - 2.17.92

Class DBEngineVersion

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

engine

engineVersion

dbParameterGroupFamily

dbEngineDescription

dbEngineVersionDescription

defaultCharacterSet

hasSupportedCharacterSets

supportedCharacterSets

hasSupportedNcharCharacterSets

supportedNcharCharacterSets

hasValidUpgradeTarget

validUpgradeTarget

hasSupportedTimezones

supportedTimezones

hasExportableLogTypes

exportableLogTypes

supportsLogExportsToCloudwatchLogs

supportsReadReplica

hasSupportedEngineModes

supportedEngineModes

hasSupportedFeatureNames

supportedFeatureNames

status

supportsParallelQuery

supportsGlobalDatabases

majorEngineVersion

databaseInstallationFilesS3BucketName

databaseInstallationFilesS3Prefix

dbEngineVersionArn

kmsKeyId

createTime

hasTagList

tagList

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields