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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a custom DB engine version (CEV).

Synopsis

data CreateCustomDBEngineVersion = CreateCustomDBEngineVersion' {
- databaseInstallationFilesS3BucketName :: Maybe Text
- databaseInstallationFilesS3Prefix :: Maybe Text
- description :: Maybe Text
- imageId :: Maybe Text
- kmsKeyId :: Maybe Text
- manifest :: Maybe Text
- tags :: Maybe [Tag]
- engine :: Text
- engineVersion :: Text
}
newCreateCustomDBEngineVersion :: Text -> Text -> CreateCustomDBEngineVersion
createCustomDBEngineVersion_databaseInstallationFilesS3BucketName :: Lens' CreateCustomDBEngineVersion (Maybe Text)
createCustomDBEngineVersion_databaseInstallationFilesS3Prefix :: Lens' CreateCustomDBEngineVersion (Maybe Text)
createCustomDBEngineVersion_description :: Lens' CreateCustomDBEngineVersion (Maybe Text)
createCustomDBEngineVersion_imageId :: Lens' CreateCustomDBEngineVersion (Maybe Text)
createCustomDBEngineVersion_kmsKeyId :: Lens' CreateCustomDBEngineVersion (Maybe Text)
createCustomDBEngineVersion_manifest :: Lens' CreateCustomDBEngineVersion (Maybe Text)
createCustomDBEngineVersion_tags :: Lens' CreateCustomDBEngineVersion (Maybe [Tag])
createCustomDBEngineVersion_engine :: Lens' CreateCustomDBEngineVersion Text
createCustomDBEngineVersion_engineVersion :: Lens' CreateCustomDBEngineVersion Text
data DBEngineVersion = DBEngineVersion' {
- createTime :: Maybe ISO8601
- customDBEngineVersionManifest :: Maybe Text
- dbEngineDescription :: Maybe Text
- dbEngineMediaType :: Maybe Text
- dbEngineVersionArn :: Maybe Text
- dbEngineVersionDescription :: Maybe Text
- dbParameterGroupFamily :: Maybe Text
- databaseInstallationFilesS3BucketName :: Maybe Text
- databaseInstallationFilesS3Prefix :: Maybe Text
- defaultCharacterSet :: Maybe CharacterSet
- engine :: Maybe Text
- engineVersion :: Maybe Text
- exportableLogTypes :: Maybe [Text]
- image :: Maybe CustomDBEngineVersionAMI
- kmsKeyId :: Maybe Text
- majorEngineVersion :: Maybe Text
- status :: Maybe Text
- supportedCACertificateIdentifiers :: Maybe [Text]
- supportedCharacterSets :: Maybe [CharacterSet]
- supportedEngineModes :: Maybe [Text]
- supportedFeatureNames :: Maybe [Text]
- supportedNcharCharacterSets :: Maybe [CharacterSet]
- supportedTimezones :: Maybe [Timezone]
- supportsBabelfish :: Maybe Bool
- supportsCertificateRotationWithoutRestart :: Maybe Bool
- supportsGlobalDatabases :: Maybe Bool
- supportsLogExportsToCloudwatchLogs :: Maybe Bool
- supportsParallelQuery :: Maybe Bool
- supportsReadReplica :: Maybe Bool
- tagList :: Maybe [Tag]
- validUpgradeTarget :: Maybe [UpgradeTarget]
}
newDBEngineVersion :: DBEngineVersion
dbEngineVersion_createTime :: Lens' DBEngineVersion (Maybe UTCTime)
dbEngineVersion_customDBEngineVersionManifest :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_dbEngineDescription :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_dbEngineMediaType :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_dbEngineVersionArn :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_dbEngineVersionDescription :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_dbParameterGroupFamily :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_databaseInstallationFilesS3BucketName :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_databaseInstallationFilesS3Prefix :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_defaultCharacterSet :: Lens' DBEngineVersion (Maybe CharacterSet)
dbEngineVersion_engine :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_engineVersion :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_exportableLogTypes :: Lens' DBEngineVersion (Maybe [Text])
dbEngineVersion_image :: Lens' DBEngineVersion (Maybe CustomDBEngineVersionAMI)
dbEngineVersion_kmsKeyId :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_majorEngineVersion :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_status :: Lens' DBEngineVersion (Maybe Text)
dbEngineVersion_supportedCACertificateIdentifiers :: Lens' DBEngineVersion (Maybe [Text])
dbEngineVersion_supportedCharacterSets :: Lens' DBEngineVersion (Maybe [CharacterSet])
dbEngineVersion_supportedEngineModes :: Lens' DBEngineVersion (Maybe [Text])
dbEngineVersion_supportedFeatureNames :: Lens' DBEngineVersion (Maybe [Text])
dbEngineVersion_supportedNcharCharacterSets :: Lens' DBEngineVersion (Maybe [CharacterSet])
dbEngineVersion_supportedTimezones :: Lens' DBEngineVersion (Maybe [Timezone])
dbEngineVersion_supportsBabelfish :: Lens' DBEngineVersion (Maybe Bool)
dbEngineVersion_supportsCertificateRotationWithoutRestart :: Lens' DBEngineVersion (Maybe Bool)
dbEngineVersion_supportsGlobalDatabases :: Lens' DBEngineVersion (Maybe Bool)
dbEngineVersion_supportsLogExportsToCloudwatchLogs :: Lens' DBEngineVersion (Maybe Bool)
dbEngineVersion_supportsParallelQuery :: Lens' DBEngineVersion (Maybe Bool)
dbEngineVersion_supportsReadReplica :: Lens' DBEngineVersion (Maybe Bool)
dbEngineVersion_tagList :: Lens' DBEngineVersion (Maybe [Tag])
dbEngineVersion_validUpgradeTarget :: Lens' DBEngineVersion (Maybe [UpgradeTarget])

Creating a Request

data CreateCustomDBEngineVersion Source #

See: newCreateCustomDBEngineVersion smart constructor.

Constructors

CreateCustomDBEngineVersion'

Fields

databaseInstallationFilesS3BucketName :: Maybe Text
The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files.
databaseInstallationFilesS3Prefix :: Maybe Text
The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.
description :: Maybe Text
An optional description of your CEV.
imageId :: Maybe Text
The ID of the AMI. An AMI ID is required to create a CEV for RDS Custom for SQL Server.
kmsKeyId :: Maybe Text
The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.
If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service Developer Guide.
You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.
manifest :: Maybe Text
The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
The following JSON fields are valid:
MediaImportTemplateVersion
Version of the CEV manifest. The date is in the format YYYY-MM-DD.
databaseInstallationFileNames
Ordered list of installation files for the CEV.
opatchFileNames
Ordered list of OPatch installers used for the Oracle DB engine.
psuRuPatchFileNames
The PSU and RU patches for this CEV.
OtherPatchFileNames
The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.
For more information, see Creating the CEV manifest in the Amazon RDS User Guide.
tags :: Maybe [Tag]
engine :: Text
The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee.
engineVersion :: Text
The name of your CEV. The name format is 19.customized_string. For example, a valid CEV name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.

Instances

Instances details

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

newCreateCustomDBEngineVersion Source #

Arguments

:: Text	`CreateCustomDBEngineVersion`
-> Text	`CreateCustomDBEngineVersion`
-> CreateCustomDBEngineVersion

Create a value of CreateCustomDBEngineVersion 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:

CreateCustomDBEngineVersion, createCustomDBEngineVersion_databaseInstallationFilesS3BucketName - The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files.

CreateCustomDBEngineVersion, createCustomDBEngineVersion_databaseInstallationFilesS3Prefix - The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.

CreateCustomDBEngineVersion, createCustomDBEngineVersion_description - An optional description of your CEV.

CreateCustomDBEngineVersion, createCustomDBEngineVersion_imageId - The ID of the AMI. An AMI ID is required to create a CEV for RDS Custom for SQL Server.

CreateCustomDBEngineVersion, createCustomDBEngineVersion_kmsKeyId - The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.

If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service Developer Guide.

You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.

$sel:manifest:CreateCustomDBEngineVersion', createCustomDBEngineVersion_manifest - The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.

The following JSON fields are valid:

MediaImportTemplateVersion: Version of the CEV manifest. The date is in the format YYYY-MM-DD.
databaseInstallationFileNames: Ordered list of installation files for the CEV.
opatchFileNames: Ordered list of OPatch installers used for the Oracle DB engine.
psuRuPatchFileNames: The PSU and RU patches for this CEV.
OtherPatchFileNames: The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.

For more information, see Creating the CEV manifest in the Amazon RDS User Guide.

$sel:tags:CreateCustomDBEngineVersion', createCustomDBEngineVersion_tags - Undocumented member.

CreateCustomDBEngineVersion, createCustomDBEngineVersion_engine - The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee.

CreateCustomDBEngineVersion, createCustomDBEngineVersion_engineVersion - The name of your CEV. The name format is 19.customized_string. For example, a valid CEV name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.

Request Lenses

createCustomDBEngineVersion_databaseInstallationFilesS3BucketName :: Lens' CreateCustomDBEngineVersion (Maybe Text) Source #

The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files.

createCustomDBEngineVersion_databaseInstallationFilesS3Prefix :: Lens' CreateCustomDBEngineVersion (Maybe Text) Source #

The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.

createCustomDBEngineVersion_description :: Lens' CreateCustomDBEngineVersion (Maybe Text) Source #

An optional description of your CEV.

createCustomDBEngineVersion_imageId :: Lens' CreateCustomDBEngineVersion (Maybe Text) Source #

The ID of the AMI. An AMI ID is required to create a CEV for RDS Custom for SQL Server.

createCustomDBEngineVersion_kmsKeyId :: Lens' CreateCustomDBEngineVersion (Maybe Text) Source #

The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.

If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service Developer Guide.

You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.

createCustomDBEngineVersion_manifest :: Lens' CreateCustomDBEngineVersion (Maybe Text) Source #

The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.

The following JSON fields are valid:

MediaImportTemplateVersion: Version of the CEV manifest. The date is in the format YYYY-MM-DD.
databaseInstallationFileNames: Ordered list of installation files for the CEV.
opatchFileNames: Ordered list of OPatch installers used for the Oracle DB engine.
psuRuPatchFileNames: The PSU and RU patches for this CEV.
OtherPatchFileNames: The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.

For more information, see Creating the CEV manifest in the Amazon RDS User Guide.

createCustomDBEngineVersion_tags :: Lens' CreateCustomDBEngineVersion (Maybe [Tag]) Source #

Undocumented member.

createCustomDBEngineVersion_engine :: Lens' CreateCustomDBEngineVersion Text Source #

The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee.

createCustomDBEngineVersion_engineVersion :: Lens' CreateCustomDBEngineVersion Text Source #

The name of your CEV. The name format is 19.customized_string. For example, a valid CEV name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per 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.