Class DBEngineVersion

java.lang.Object
software.amazon.awssdk.services.rds.model.DBEngineVersion
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DBEngineVersion.Builder,DBEngineVersion>
@Generated("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:

  • Method Details

    • engine

      public final String engine()

      The name of the database engine.

      Returns:
      The name of the database engine.

    • majorEngineVersion

      public final String majorEngineVersion()

      The major engine version of the CEV.

      Returns:
      The major engine version of the CEV.

    • engineVersion

      public final String engineVersion()

      The version number of the database engine.

      Returns:
      The version number of the database engine.

    • 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.

    • 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.

    • 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.

    • dbEngineVersionArn

      public final String dbEngineVersionArn()

      The ARN of the custom engine version.

      Returns:
      The ARN of the custom engine version.

    • 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.

    • 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.

    • 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()

      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 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()

      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.

    • 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.

    • 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.

    • 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 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.

    • 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 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.