Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.ModifyCustomDBEngineVersion

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions.

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event.

For more information, see Modifying CEV status in the Amazon RDS User Guide.

Synopsis

Creating a Request

data ModifyCustomDBEngineVersion Source #

See: newModifyCustomDBEngineVersion smart constructor.

Constructors

ModifyCustomDBEngineVersion'

Fields

description :: Maybe Text
An optional description of your CEV.
status :: Maybe CustomEngineVersionStatus
The availability status to be assigned to the CEV. Valid values are as follows:
available
You can use this CEV to create a new RDS Custom DB instance.
inactive
You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.
You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.
engine :: Text
The DB engine. The only supported value is custom-oracle-ee.
engineVersion :: Text
The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.

Instances

Instances details

ToHeaders ModifyCustomDBEngineVersion Source #
Instance details Defined in Amazonka.RDS.ModifyCustomDBEngineVersion Methods toHeaders :: ModifyCustomDBEngineVersion -> [Header] #
ToPath ModifyCustomDBEngineVersion Source #
Instance details Defined in Amazonka.RDS.ModifyCustomDBEngineVersion Methods toPath :: ModifyCustomDBEngineVersion -> ByteString #
ToQuery ModifyCustomDBEngineVersion Source #
Instance details Defined in Amazonka.RDS.ModifyCustomDBEngineVersion Methods toQuery :: ModifyCustomDBEngineVersion -> QueryString #
AWSRequest ModifyCustomDBEngineVersion Source #
Instance details Defined in Amazonka.RDS.ModifyCustomDBEngineVersion Associated Types type AWSResponse ModifyCustomDBEngineVersion # Methods request :: (Service -> Service) -> ModifyCustomDBEngineVersion -> Request ModifyCustomDBEngineVersion # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyCustomDBEngineVersion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyCustomDBEngineVersion))) #
Generic ModifyCustomDBEngineVersion Source #
Instance details Defined in Amazonka.RDS.ModifyCustomDBEngineVersion Associated Types type Rep ModifyCustomDBEngineVersion :: Type -> Type # Methods from :: ModifyCustomDBEngineVersion -> Rep ModifyCustomDBEngineVersion x # to :: Rep ModifyCustomDBEngineVersion x -> ModifyCustomDBEngineVersion #
Read ModifyCustomDBEngineVersion Source #
Instance details Defined in Amazonka.RDS.ModifyCustomDBEngineVersion Methods readsPrec :: Int -> ReadS ModifyCustomDBEngineVersion # readList :: ReadS [ModifyCustomDBEngineVersion] # readPrec :: ReadPrec ModifyCustomDBEngineVersion # readListPrec :: ReadPrec [ModifyCustomDBEngineVersion] #
Show ModifyCustomDBEngineVersion Source #
Instance details Defined in Amazonka.RDS.ModifyCustomDBEngineVersion Methods showsPrec :: Int -> ModifyCustomDBEngineVersion -> ShowS # show :: ModifyCustomDBEngineVersion -> String # showList :: [ModifyCustomDBEngineVersion] -> ShowS #
NFData ModifyCustomDBEngineVersion Source #
Instance details Defined in Amazonka.RDS.ModifyCustomDBEngineVersion Methods rnf :: ModifyCustomDBEngineVersion -> () #
Eq ModifyCustomDBEngineVersion Source #
Instance details Defined in Amazonka.RDS.ModifyCustomDBEngineVersion Methods (==) :: ModifyCustomDBEngineVersion -> ModifyCustomDBEngineVersion -> Bool # (/=) :: ModifyCustomDBEngineVersion -> ModifyCustomDBEngineVersion -> Bool #
Hashable ModifyCustomDBEngineVersion Source #
Instance details Defined in Amazonka.RDS.ModifyCustomDBEngineVersion Methods hashWithSalt :: Int -> ModifyCustomDBEngineVersion -> Int # hash :: ModifyCustomDBEngineVersion -> Int #
type AWSResponse ModifyCustomDBEngineVersion Source #
Instance details Defined in Amazonka.RDS.ModifyCustomDBEngineVersion type AWSResponse ModifyCustomDBEngineVersion = DBEngineVersion
type Rep ModifyCustomDBEngineVersion Source #
Instance details Defined in Amazonka.RDS.ModifyCustomDBEngineVersion type Rep ModifyCustomDBEngineVersion = D1 ('MetaData "ModifyCustomDBEngineVersion" "Amazonka.RDS.ModifyCustomDBEngineVersion" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ModifyCustomDBEngineVersion'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomEngineVersionStatus))) :: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newModifyCustomDBEngineVersion Source #

Arguments

:: Text	`ModifyCustomDBEngineVersion`
-> Text	`ModifyCustomDBEngineVersion`
-> ModifyCustomDBEngineVersion

Create a value of ModifyCustomDBEngineVersion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ModifyCustomDBEngineVersion, modifyCustomDBEngineVersion_description - An optional description of your CEV.

ModifyCustomDBEngineVersion, modifyCustomDBEngineVersion_status - The availability status to be assigned to the CEV. Valid values are as follows:

available: You can use this CEV to create a new RDS Custom DB instance.
inactive: You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.

You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.

ModifyCustomDBEngineVersion, modifyCustomDBEngineVersion_engine - The DB engine. The only supported value is custom-oracle-ee.

ModifyCustomDBEngineVersion, modifyCustomDBEngineVersion_engineVersion - The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.

Request Lenses

modifyCustomDBEngineVersion_description :: Lens' ModifyCustomDBEngineVersion (Maybe Text) Source #

An optional description of your CEV.

modifyCustomDBEngineVersion_status :: Lens' ModifyCustomDBEngineVersion (Maybe CustomEngineVersionStatus) Source #

The availability status to be assigned to the CEV. Valid values are as follows:

available: You can use this CEV to create a new RDS Custom DB instance.
inactive: You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.

You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.

modifyCustomDBEngineVersion_engine :: Lens' ModifyCustomDBEngineVersion Text Source #

The DB engine. The only supported value is custom-oracle-ee.

modifyCustomDBEngineVersion_engineVersion :: Lens' ModifyCustomDBEngineVersion Text Source #

The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.

Destructuring the Response

data DBEngineVersion Source #

This data type is used as a response element in the action DescribeDBEngineVersions.

See: newDBEngineVersion smart constructor.

Constructors

DBEngineVersion'

Fields

createTime :: Maybe ISO8601
The creation time of the DB engine version.
customDBEngineVersionManifest :: Maybe Text
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.
dbEngineDescription :: Maybe Text
The description of the database engine.
dbEngineMediaType :: Maybe Text
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
dbEngineVersionArn :: Maybe Text
The ARN of the custom engine version.
dbEngineVersionDescription :: Maybe Text
The description of the database engine version.
dbParameterGroupFamily :: Maybe Text
The name of the DB parameter group family for the database engine.
databaseInstallationFilesS3BucketName :: Maybe Text
The name of the Amazon S3 bucket that contains your database installation files.
databaseInstallationFilesS3Prefix :: Maybe Text
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
defaultCharacterSet :: Maybe CharacterSet
The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.
engine :: Maybe Text
The name of the database engine.
engineVersion :: Maybe Text
The version number of the database engine.
exportableLogTypes :: Maybe [Text]
The types of logs that the database engine has available for export to CloudWatch Logs.
image :: Maybe CustomDBEngineVersionAMI
The EC2 image
kmsKeyId :: Maybe Text
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
majorEngineVersion :: Maybe Text
The major engine version of the CEV.
status :: Maybe Text
The status of the DB engine version, either available or deprecated.
supportedCACertificateIdentifiers :: Maybe [Text]
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.
supportedCharacterSets :: Maybe [CharacterSet]
A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
supportedEngineModes :: Maybe [Text]
A list of the supported DB engine modes.
supportedFeatureNames :: Maybe [Text]
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.
supportedNcharCharacterSets :: Maybe [CharacterSet]
A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
supportedTimezones :: Maybe [Timezone]
A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
supportsBabelfish :: Maybe Bool
A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
supportsCertificateRotationWithoutRestart :: Maybe Bool
A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
supportsGlobalDatabases :: Maybe Bool
A value that indicates whether you can use Aurora global databases with a specific DB engine version.
supportsLogExportsToCloudwatchLogs :: Maybe Bool
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
supportsParallelQuery :: Maybe Bool
A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
supportsReadReplica :: Maybe Bool
Indicates whether the database engine version supports read replicas.
tagList :: Maybe [Tag]
validUpgradeTarget :: Maybe [UpgradeTarget]
A list of engine versions that this database engine version can be upgraded to.

Instances

Instances details

FromXML DBEngineVersion Source #
Instance details Defined in Amazonka.RDS.Types.DBEngineVersion Methods parseXML :: [Node] -> Either String DBEngineVersion #
Generic DBEngineVersion Source #
Instance details Defined in Amazonka.RDS.Types.DBEngineVersion Associated Types type Rep DBEngineVersion :: Type -> Type # Methods from :: DBEngineVersion -> Rep DBEngineVersion x # to :: Rep DBEngineVersion x -> DBEngineVersion #
Read DBEngineVersion Source #
Instance details Defined in Amazonka.RDS.Types.DBEngineVersion Methods readsPrec :: Int -> ReadS DBEngineVersion # readList :: ReadS [DBEngineVersion] # readPrec :: ReadPrec DBEngineVersion # readListPrec :: ReadPrec [DBEngineVersion] #
Show DBEngineVersion Source #
Instance details Defined in Amazonka.RDS.Types.DBEngineVersion Methods showsPrec :: Int -> DBEngineVersion -> ShowS # show :: DBEngineVersion -> String # showList :: [DBEngineVersion] -> ShowS #
NFData DBEngineVersion Source #
Instance details Defined in Amazonka.RDS.Types.DBEngineVersion Methods rnf :: DBEngineVersion -> () #
Eq DBEngineVersion Source #
Instance details Defined in Amazonka.RDS.Types.DBEngineVersion Methods (==) :: DBEngineVersion -> DBEngineVersion -> Bool # (/=) :: DBEngineVersion -> DBEngineVersion -> Bool #
Hashable DBEngineVersion Source #
Instance details Defined in Amazonka.RDS.Types.DBEngineVersion Methods hashWithSalt :: Int -> DBEngineVersion -> Int # hash :: DBEngineVersion -> Int #
type Rep DBEngineVersion Source #
Instance details Defined in Amazonka.RDS.Types.DBEngineVersion type Rep DBEngineVersion = D1 ('MetaData "DBEngineVersion" "Amazonka.RDS.Types.DBEngineVersion" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBEngineVersion'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "customDBEngineVersionManifest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbEngineDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "dbEngineMediaType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbEngineVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dbEngineVersionDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "databaseInstallationFilesS3BucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "databaseInstallationFilesS3Prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "defaultCharacterSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CharacterSet)) :: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "exportableLogTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "image") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomDBEngineVersionAMI)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: ((((S1 ('MetaSel ('Just "majorEngineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "supportedCACertificateIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "supportedCharacterSets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CharacterSet])))) :: ((S1 ('MetaSel ('Just "supportedEngineModes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "supportedFeatureNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "supportedNcharCharacterSets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CharacterSet])) :: S1 ('MetaSel ('Just "supportedTimezones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Timezone]))))) :: (((S1 ('MetaSel ('Just "supportsBabelfish") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "supportsCertificateRotationWithoutRestart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "supportsGlobalDatabases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "supportsLogExportsToCloudwatchLogs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "supportsParallelQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "supportsReadReplica") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "tagList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "validUpgradeTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UpgradeTarget]))))))))

newDBEngineVersion :: DBEngineVersion Source #

Create a value of DBEngineVersion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createTime:DBEngineVersion', dbEngineVersion_createTime - The creation time of the DB engine version.

$sel:customDBEngineVersionManifest:DBEngineVersion', dbEngineVersion_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.

$sel:dbEngineDescription:DBEngineVersion', dbEngineVersion_dbEngineDescription - The description of the database engine.

$sel:dbEngineMediaType:DBEngineVersion', dbEngineVersion_dbEngineMediaType - A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

$sel:dbEngineVersionArn:DBEngineVersion', dbEngineVersion_dbEngineVersionArn - The ARN of the custom engine version.

$sel:dbEngineVersionDescription:DBEngineVersion', dbEngineVersion_dbEngineVersionDescription - The description of the database engine version.

$sel:dbParameterGroupFamily:DBEngineVersion', dbEngineVersion_dbParameterGroupFamily - The name of the DB parameter group family for the database engine.

$sel:databaseInstallationFilesS3BucketName:DBEngineVersion', dbEngineVersion_databaseInstallationFilesS3BucketName - The name of the Amazon S3 bucket that contains your database installation files.

$sel:databaseInstallationFilesS3Prefix:DBEngineVersion', dbEngineVersion_databaseInstallationFilesS3Prefix - The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.

$sel:defaultCharacterSet:DBEngineVersion', dbEngineVersion_defaultCharacterSet - The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.

DBEngineVersion, dbEngineVersion_engine - The name of the database engine.

DBEngineVersion, dbEngineVersion_engineVersion - The version number of the database engine.

$sel:exportableLogTypes:DBEngineVersion', dbEngineVersion_exportableLogTypes - The types of logs that the database engine has available for export to CloudWatch Logs.

$sel:image:DBEngineVersion', dbEngineVersion_image - The EC2 image

$sel:kmsKeyId:DBEngineVersion', dbEngineVersion_kmsKeyId - The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.

$sel:majorEngineVersion:DBEngineVersion', dbEngineVersion_majorEngineVersion - The major engine version of the CEV.

DBEngineVersion, dbEngineVersion_status - The status of the DB engine version, either available or deprecated.

$sel:supportedCACertificateIdentifiers:DBEngineVersion', dbEngineVersion_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.

$sel:supportedCharacterSets:DBEngineVersion', dbEngineVersion_supportedCharacterSets - A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

DBEngineVersion, dbEngineVersion_supportedEngineModes - A list of the supported DB engine modes.

$sel:supportedFeatureNames:DBEngineVersion', dbEngineVersion_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.

$sel:supportedNcharCharacterSets:DBEngineVersion', dbEngineVersion_supportedNcharCharacterSets - A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

$sel:supportedTimezones:DBEngineVersion', dbEngineVersion_supportedTimezones - A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

DBEngineVersion, dbEngineVersion_supportsBabelfish - A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

$sel:supportsCertificateRotationWithoutRestart:DBEngineVersion', dbEngineVersion_supportsCertificateRotationWithoutRestart - A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

DBEngineVersion, dbEngineVersion_supportsGlobalDatabases - A value that indicates whether you can use Aurora global databases with a specific DB engine version.

$sel:supportsLogExportsToCloudwatchLogs:DBEngineVersion', dbEngineVersion_supportsLogExportsToCloudwatchLogs - A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

DBEngineVersion, dbEngineVersion_supportsParallelQuery - A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

$sel:supportsReadReplica:DBEngineVersion', dbEngineVersion_supportsReadReplica - Indicates whether the database engine version supports read replicas.

$sel:tagList:DBEngineVersion', dbEngineVersion_tagList - Undocumented member.

$sel:validUpgradeTarget:DBEngineVersion', dbEngineVersion_validUpgradeTarget - A list of engine versions that this database engine version can be upgraded to.

Response Lenses

dbEngineVersion_createTime :: Lens' DBEngineVersion (Maybe UTCTime) Source #

The creation time of the DB engine version.

dbEngineVersion_customDBEngineVersionManifest :: Lens' DBEngineVersion (Maybe Text) Source #

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.

dbEngineVersion_dbEngineDescription :: Lens' DBEngineVersion (Maybe Text) Source #

The description of the database engine.

dbEngineVersion_dbEngineMediaType :: Lens' DBEngineVersion (Maybe Text) Source #

A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

dbEngineVersion_dbEngineVersionArn :: Lens' DBEngineVersion (Maybe Text) Source #

The ARN of the custom engine version.

dbEngineVersion_dbEngineVersionDescription :: Lens' DBEngineVersion (Maybe Text) Source #

The description of the database engine version.

dbEngineVersion_dbParameterGroupFamily :: Lens' DBEngineVersion (Maybe Text) Source #

The name of the DB parameter group family for the database engine.

dbEngineVersion_databaseInstallationFilesS3BucketName :: Lens' DBEngineVersion (Maybe Text) Source #

The name of the Amazon S3 bucket that contains your database installation files.

dbEngineVersion_databaseInstallationFilesS3Prefix :: Lens' DBEngineVersion (Maybe Text) Source #

The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.

dbEngineVersion_defaultCharacterSet :: Lens' DBEngineVersion (Maybe CharacterSet) Source #

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.

dbEngineVersion_engine :: Lens' DBEngineVersion (Maybe Text) Source #

The name of the database engine.

dbEngineVersion_engineVersion :: Lens' DBEngineVersion (Maybe Text) Source #

The version number of the database engine.

dbEngineVersion_exportableLogTypes :: Lens' DBEngineVersion (Maybe [Text]) Source #

The types of logs that the database engine has available for export to CloudWatch Logs.

dbEngineVersion_image :: Lens' DBEngineVersion (Maybe CustomDBEngineVersionAMI) Source #

The EC2 image

dbEngineVersion_kmsKeyId :: Lens' DBEngineVersion (Maybe Text) Source #

The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.

dbEngineVersion_majorEngineVersion :: Lens' DBEngineVersion (Maybe Text) Source #

The major engine version of the CEV.

dbEngineVersion_status :: Lens' DBEngineVersion (Maybe Text) Source #

The status of the DB engine version, either available or deprecated.

dbEngineVersion_supportedCACertificateIdentifiers :: Lens' DBEngineVersion (Maybe [Text]) Source #

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.

dbEngineVersion_supportedCharacterSets :: Lens' DBEngineVersion (Maybe [CharacterSet]) Source #

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

dbEngineVersion_supportedEngineModes :: Lens' DBEngineVersion (Maybe [Text]) Source #

A list of the supported DB engine modes.

dbEngineVersion_supportedFeatureNames :: Lens' DBEngineVersion (Maybe [Text]) Source #

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.

dbEngineVersion_supportedNcharCharacterSets :: Lens' DBEngineVersion (Maybe [CharacterSet]) Source #

A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

dbEngineVersion_supportedTimezones :: Lens' DBEngineVersion (Maybe [Timezone]) Source #

A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

dbEngineVersion_supportsBabelfish :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

dbEngineVersion_supportsCertificateRotationWithoutRestart :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

dbEngineVersion_supportsGlobalDatabases :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether you can use Aurora global databases with a specific DB engine version.

dbEngineVersion_supportsLogExportsToCloudwatchLogs :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

dbEngineVersion_supportsParallelQuery :: Lens' DBEngineVersion (Maybe Bool) Source #

A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

dbEngineVersion_supportsReadReplica :: Lens' DBEngineVersion (Maybe Bool) Source #

Indicates whether the database engine version supports read replicas.

dbEngineVersion_tagList :: Lens' DBEngineVersion (Maybe [Tag]) Source #

Undocumented member.

dbEngineVersion_validUpgradeTarget :: Lens' DBEngineVersion (Maybe [UpgradeTarget]) Source #

A list of engine versions that this database engine version can be upgraded to.