amazonka-rds-2.0: Amazon Relational Database Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RDS.DeleteCustomDBEngineVersion

Description

Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:

  • The CEV must not be the default for RDS Custom. If it is, change the default before running this command.
  • The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.

Typically, deletion takes a few minutes.

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 DeleteCustomDbEngineVersion 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 DeleteCustomDbEngineVersion event.

For more information, see Deleting a CEV in the Amazon RDS User Guide.

Synopsis

Creating a Request

data DeleteCustomDBEngineVersion Source #

See: newDeleteCustomDBEngineVersion smart constructor.

Constructors

DeleteCustomDBEngineVersion' 

Fields

  • engine :: Text

    The database engine. The only supported engine is custom-oracle-ee.

  • engineVersion :: Text

    The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.

Instances

Instances details
ToHeaders DeleteCustomDBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.DeleteCustomDBEngineVersion

ToPath DeleteCustomDBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.DeleteCustomDBEngineVersion

ToQuery DeleteCustomDBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.DeleteCustomDBEngineVersion

AWSRequest DeleteCustomDBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.DeleteCustomDBEngineVersion

Generic DeleteCustomDBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.DeleteCustomDBEngineVersion

Associated Types

type Rep DeleteCustomDBEngineVersion :: Type -> Type #

Read DeleteCustomDBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.DeleteCustomDBEngineVersion

Show DeleteCustomDBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.DeleteCustomDBEngineVersion

NFData DeleteCustomDBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.DeleteCustomDBEngineVersion

Eq DeleteCustomDBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.DeleteCustomDBEngineVersion

Hashable DeleteCustomDBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.DeleteCustomDBEngineVersion

type AWSResponse DeleteCustomDBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.DeleteCustomDBEngineVersion

type Rep DeleteCustomDBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.DeleteCustomDBEngineVersion

type Rep DeleteCustomDBEngineVersion = D1 ('MetaData "DeleteCustomDBEngineVersion" "Amazonka.RDS.DeleteCustomDBEngineVersion" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DeleteCustomDBEngineVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteCustomDBEngineVersion Source #

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

DeleteCustomDBEngineVersion, deleteCustomDBEngineVersion_engine - The database engine. The only supported engine is custom-oracle-ee.

DeleteCustomDBEngineVersion, deleteCustomDBEngineVersion_engineVersion - The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.

Request Lenses

deleteCustomDBEngineVersion_engine :: Lens' DeleteCustomDBEngineVersion Text Source #

The database engine. The only supported engine is custom-oracle-ee.

deleteCustomDBEngineVersion_engineVersion :: Lens' DeleteCustomDBEngineVersion Text Source #

The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, 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

Instances

Instances details
FromXML DBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.DBEngineVersion

Generic DBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.DBEngineVersion

Associated Types

type Rep DBEngineVersion :: Type -> Type #

Read DBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.DBEngineVersion

Show DBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.DBEngineVersion

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

Hashable DBEngineVersion Source # 
Instance details

Defined in Amazonka.RDS.Types.DBEngineVersion

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_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_validUpgradeTarget :: Lens' DBEngineVersion (Maybe [UpgradeTarget]) Source #

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