ModifyCustomDBEngineVersion
Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling
DescribeDBEngineVersions
.
Note
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with
AWS 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.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Engine
-
The database engine. RDS Custom for Oracle supports the following values:
-
custom-oracle-ee
-
custom-oracle-ee-cdb
-
custom-oracle-se2
-
custom-oracle-se2-cdb
Type: String
Length Constraints: Minimum length of 1. Maximum length of 35.
Pattern:
^[A-Za-z0-9-]{1,35}$
Required: Yes
-
- 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
andEngineVersion
is unique per customer per AWS Region.Type: String
Length Constraints: Minimum length of 1. Maximum length of 60.
Pattern:
^[a-z0-9_.-]{1,60}$
Required: Yes
- Description
-
An optional description of your CEV.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
.*
Required: No
- 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
toinactive
, and frominactive
back toavailable
. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.Type: String
Valid Values:
available | inactive | inactive-except-restore
Required: No
Response Elements
The following elements are returned by the service.
- CreateTime
-
The creation time of the DB engine version.
Type: Timestamp
- 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 51000.
Pattern:
[\s\S]*
- DatabaseInstallationFilesS3BucketName
-
The name of the Amazon S3 bucket that contains your database installation files.
Type: String
- DatabaseInstallationFilesS3Prefix
-
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
Type: String
- DBEngineDescription
-
The description of the database engine.
Type: String
- DBEngineMediaType
-
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
Type: String
- DBEngineVersionArn
-
The ARN of the custom engine version.
Type: String
- DBEngineVersionDescription
-
The description of the database engine version.
Type: String
- DBParameterGroupFamily
-
The name of the DB parameter group family for the database engine.
Type: String
- DefaultCharacterSet
-
The default character set for new instances of this engine version, if the
CharacterSetName
parameter of the CreateDBInstance API isn't specified.Type: CharacterSet object
- Engine
-
The name of the database engine.
Type: String
- EngineVersion
-
The version number of the database engine.
Type: String
- ExportableLogTypes.member.N
-
The types of logs that the database engine has available for export to CloudWatch Logs.
Type: Array of strings
- Image
-
The EC2 image
Type: CustomDBEngineVersionAMI object
- KMSKeyId
-
The AWS KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
Type: String
- MajorEngineVersion
-
The major engine version of the CEV.
Type: String
- Status
-
The status of the DB engine version, either
available
ordeprecated
.Type: String
- SupportedCACertificateIdentifiers.member.N
-
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.
Type: Array of strings
- SupportedCharacterSets.CharacterSet.N
-
A list of the character sets supported by this engine for the
CharacterSetName
parameter of theCreateDBInstance
operation.Type: Array of CharacterSet objects
- SupportedEngineModes.member.N
-
A list of the supported DB engine modes.
Type: Array of strings
- SupportedFeatureNames.member.N
-
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 AWS 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 AWS 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.Type: Array of strings
- SupportedNcharCharacterSets.CharacterSet.N
-
A list of the character sets supported by the Oracle DB engine for the
NcharCharacterSetName
parameter of theCreateDBInstance
operation.Type: Array of CharacterSet objects
- SupportedTimezones.Timezone.N
-
A list of the time zones supported by this engine for the
Timezone
parameter of theCreateDBInstance
action.Type: Array of Timezone objects
- SupportsBabelfish
-
Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
Type: Boolean
- SupportsCertificateRotationWithoutRestart
-
Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
Type: Boolean
- SupportsGlobalDatabases
-
Indicates whether you can use Aurora global databases with a specific DB engine version.
Type: Boolean
- SupportsIntegrations
-
Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
Type: Boolean
- SupportsLimitlessDatabase
-
Indicates whether the DB engine version supports Aurora Limitless Database.
Type: Boolean
- SupportsLocalWriteForwarding
-
Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
Type: Boolean
- SupportsLogExportsToCloudwatchLogs
-
Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
Type: Boolean
- SupportsParallelQuery
-
Indicates whether you can use Aurora parallel query with a specific DB engine version.
Type: Boolean
- SupportsReadReplica
-
Indicates whether the database engine version supports read replicas.
Type: Boolean
- TagList.Tag.N
-
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Type: Array of Tag objects
- ValidUpgradeTarget.UpgradeTarget.N
-
A list of engine versions that this database engine version can be upgraded to.
Type: Array of UpgradeTarget objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- CustomDBEngineVersionNotFoundFault
-
The specified CEV was not found.
HTTP Status Code: 404
- InvalidCustomDBEngineVersionStateFault
-
You can't delete the CEV.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of ModifyCustomDBEngineVersion.
Sample Request
https://rds.us-east-1.amazonaws.com/
?Engine=19.cev1
&EngineVersion=custom-oracle-ee
&Description=test
&Status=available
&Operation=ModifyCustomDBEngineVersion
&Version=1999-01-01
&AWSAccessKeyId=ABCDEF1JKLMNOPQRSTUV
&SignatureVersion=2
&SignatureMethod=HmacSHA1
&Timestamp=2021-10-13T21%3A38%3A59.000Z
&Signature=vJeEgn2kGiAyCI7uRVAOXqGPiHc%3D
Sample Response
<ModifyCustomDBEngineVersionResponse xmlns="http://rds.amazonaws.com/doc/1999-01-01/">
<ModifyCustomDBEngineVersionResult>
<DatabaseInstallationFilesS3Prefix>123456789012/cev1</DatabaseInstallationFilesS3Prefix>
<MajorEngineVersion>19</MajorEngineVersion>
<DBEngineVersionArn>arn:aws:rds:us-east-1:123456789012:cev:custom-oracle-ee/19.cev1/123ab45c-abc1-1234-1234-123a45b12345</DBEngineVersionArn> <DBEngineVersionDescription>foo</DBEngineVersionDescription>
<SupportsGlobalDatabases>false</SupportsGlobalDatabases>
<SupportsParallelQuery>false</SupportsParallelQuery>
<Engine>custom-oracle-ee</Engine>
<KMSKeyId>arn:aws:kms:us-east-1:123456789012:key/12ab3c4d-1234-12a3-1aa2-12a3bcdefghi</KMSKeyId>
<EngineVersion>19.cev1</EngineVersion>
<SupportsReadReplica>false</SupportsReadReplica>
<SupportsCluster>false</SupportsCluster>
<CreateTime>2021-07-03T00:41:23.515Z</CreateTime>
<DatabaseInstallationFilesS3BucketName>1-custom-installation-files</DatabaseInstallationFilesS3BucketName>
<SupportsLogExportsToCloudwatchLogs>false</SupportsLogExportsToCloudwatchLogs>
<AMIs>
<member>
<Id>ami-0230ab8f4967332aa</Id>
<Status>active</Status>
</member>
</AMIs>
<DBEngineDescription>Oracle Database server EE for Custom</DBEngineDescription>
<Status>available</Status>
</ModifyCustomDBEngineVersionResult>
<ResponseMetadata>
<RequestId>052dff47-5a11-48e6-82d1-77158ecf4cc9</RequestId>
</ResponseMetadata>
</ModifyCustomDBEngineVersionResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: