Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

CreateCustomDBEngineVersionCommand

Creates a custom DB engine version (CEV).

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RDSClient, CreateCustomDBEngineVersionCommand } from "@aws-sdk/client-rds"; // ES Modules import
// const { RDSClient, CreateCustomDBEngineVersionCommand } = require("@aws-sdk/client-rds"); // CommonJS import
const client = new RDSClient(config);
const input = { // CreateCustomDBEngineVersionMessage
  Engine: "STRING_VALUE", // required
  EngineVersion: "STRING_VALUE", // required
  DatabaseInstallationFilesS3BucketName: "STRING_VALUE",
  DatabaseInstallationFilesS3Prefix: "STRING_VALUE",
  ImageId: "STRING_VALUE",
  KMSKeyId: "STRING_VALUE",
  Description: "STRING_VALUE",
  Manifest: "STRING_VALUE",
  Tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE",
      Value: "STRING_VALUE",
    },
  ],
  SourceCustomDbEngineVersionIdentifier: "STRING_VALUE",
  UseAwsProvidedLatestImage: true || false,
};
const command = new CreateCustomDBEngineVersionCommand(input);
const response = await client.send(command);
// { // DBEngineVersion
//   Engine: "STRING_VALUE",
//   EngineVersion: "STRING_VALUE",
//   DBParameterGroupFamily: "STRING_VALUE",
//   DBEngineDescription: "STRING_VALUE",
//   DBEngineVersionDescription: "STRING_VALUE",
//   DefaultCharacterSet: { // CharacterSet
//     CharacterSetName: "STRING_VALUE",
//     CharacterSetDescription: "STRING_VALUE",
//   },
//   Image: { // CustomDBEngineVersionAMI
//     ImageId: "STRING_VALUE",
//     Status: "STRING_VALUE",
//   },
//   DBEngineMediaType: "STRING_VALUE",
//   SupportedCharacterSets: [ // SupportedCharacterSetsList
//     {
//       CharacterSetName: "STRING_VALUE",
//       CharacterSetDescription: "STRING_VALUE",
//     },
//   ],
//   SupportedNcharCharacterSets: [
//     {
//       CharacterSetName: "STRING_VALUE",
//       CharacterSetDescription: "STRING_VALUE",
//     },
//   ],
//   ValidUpgradeTarget: [ // ValidUpgradeTargetList
//     { // UpgradeTarget
//       Engine: "STRING_VALUE",
//       EngineVersion: "STRING_VALUE",
//       Description: "STRING_VALUE",
//       AutoUpgrade: true || false,
//       IsMajorVersionUpgrade: true || false,
//       SupportedEngineModes: [ // EngineModeList
//         "STRING_VALUE",
//       ],
//       SupportsParallelQuery: true || false,
//       SupportsGlobalDatabases: true || false,
//       SupportsBabelfish: true || false,
//       SupportsLimitlessDatabase: true || false,
//       SupportsLocalWriteForwarding: true || false,
//       SupportsIntegrations: true || false,
//     },
//   ],
//   SupportedTimezones: [ // SupportedTimezonesList
//     { // Timezone
//       TimezoneName: "STRING_VALUE",
//     },
//   ],
//   ExportableLogTypes: [ // LogTypeList
//     "STRING_VALUE",
//   ],
//   SupportsLogExportsToCloudwatchLogs: true || false,
//   SupportsReadReplica: true || false,
//   SupportedEngineModes: [
//     "STRING_VALUE",
//   ],
//   SupportedFeatureNames: [ // FeatureNameList
//     "STRING_VALUE",
//   ],
//   Status: "STRING_VALUE",
//   SupportsParallelQuery: true || false,
//   SupportsGlobalDatabases: true || false,
//   MajorEngineVersion: "STRING_VALUE",
//   DatabaseInstallationFilesS3BucketName: "STRING_VALUE",
//   DatabaseInstallationFilesS3Prefix: "STRING_VALUE",
//   DBEngineVersionArn: "STRING_VALUE",
//   KMSKeyId: "STRING_VALUE",
//   CreateTime: new Date("TIMESTAMP"),
//   TagList: [ // TagList
//     { // Tag
//       Key: "STRING_VALUE",
//       Value: "STRING_VALUE",
//     },
//   ],
//   SupportsBabelfish: true || false,
//   CustomDBEngineVersionManifest: "STRING_VALUE",
//   SupportsLimitlessDatabase: true || false,
//   SupportsCertificateRotationWithoutRestart: true || false,
//   SupportedCACertificateIdentifiers: [ // CACertificateIdentifiersList
//     "STRING_VALUE",
//   ],
//   SupportsLocalWriteForwarding: true || false,
//   SupportsIntegrations: true || false,
//   ServerlessV2FeaturesSupport: { // ServerlessV2FeaturesSupport
//     MinCapacity: Number("double"),
//     MaxCapacity: Number("double"),
//   },
// };

CreateCustomDBEngineVersionCommand Input

See CreateCustomDBEngineVersionCommandInput for more details

Parameter	Type	Description
`Engine` Required	`string \| undefined`	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`
`EngineVersion` Required	`string \| undefined`	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.
`DatabaseInstallationFilesS3BucketName`	`string \| undefined`	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`	`string \| undefined`	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`	`string \| undefined`	An optional description of your CEV.
`ImageId`	`string \| undefined`	The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs used by your CEVs by calling the DescribeDBEngineVersions operation.
`KMSKeyId`	`string \| undefined`	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`	`string \| undefined`	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.
`SourceCustomDbEngineVersionIdentifier`	`string \| undefined`	The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either `Source` or `UseAwsProvidedLatestImage`. You can't specify a different JSON manifest when you specify `SourceCustomDbEngineVersionIdentifier`.
`Tags`	`Tag[] \| undefined`	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.
`UseAwsProvidedLatestImage`	`boolean \| undefined`	Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify `UseAwsProvidedLatestImage`, you can't also specify `ImageId`.

CreateCustomDBEngineVersionCommand Output

See CreateCustomDBEngineVersionCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`CreateTime`	`Date \| undefined`	The creation time of the DB engine version.
`CustomDBEngineVersionManifest`	`string \| undefined`	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`	`string \| undefined`	The description of the database engine.
`DBEngineMediaType`	`string \| undefined`	A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
`DBEngineVersionArn`	`string \| undefined`	The ARN of the custom engine version.
`DBEngineVersionDescription`	`string \| undefined`	The description of the database engine version.
`DBParameterGroupFamily`	`string \| undefined`	The name of the DB parameter group family for the database engine.
`DatabaseInstallationFilesS3BucketName`	`string \| undefined`	The name of the Amazon S3 bucket that contains your database installation files.
`DatabaseInstallationFilesS3Prefix`	`string \| undefined`	The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
`DefaultCharacterSet`	`CharacterSet \| undefined`	The default character set for new instances of this engine version, if the `CharacterSetName` parameter of the CreateDBInstance API isn't specified.
`Engine`	`string \| undefined`	The name of the database engine.
`EngineVersion`	`string \| undefined`	The version number of the database engine.
`ExportableLogTypes`	`string[] \| undefined`	The types of logs that the database engine has available for export to CloudWatch Logs.
`Image`	`CustomDBEngineVersionAMI \| undefined`	The EC2 image
`KMSKeyId`	`string \| undefined`	The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
`MajorEngineVersion`	`string \| undefined`	The major engine version of the CEV.
`ServerlessV2FeaturesSupport`	`ServerlessV2FeaturesSupport \| undefined`	Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.
`Status`	`string \| undefined`	The status of the DB engine version, either `available` or `deprecated`.
`SupportedCACertificateIdentifiers`	`string[] \| undefined`	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`	`CharacterSet[] \| undefined`	A list of the character sets supported by this engine for the `CharacterSetName` parameter of the `CreateDBInstance` operation.
`SupportedEngineModes`	`string[] \| undefined`	A list of the supported DB engine modes.
`SupportedFeatureNames`	`string[] \| undefined`	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`	`CharacterSet[] \| undefined`	A list of the character sets supported by the Oracle DB engine for the `NcharCharacterSetName` parameter of the `CreateDBInstance` operation.
`SupportedTimezones`	`Timezone[] \| undefined`	A list of the time zones supported by this engine for the `Timezone` parameter of the `CreateDBInstance` action.
`SupportsBabelfish`	`boolean \| undefined`	Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
`SupportsCertificateRotationWithoutRestart`	`boolean \| undefined`	Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
`SupportsGlobalDatabases`	`boolean \| undefined`	Indicates whether you can use Aurora global databases with a specific DB engine version.
`SupportsIntegrations`	`boolean \| undefined`	Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
`SupportsLimitlessDatabase`	`boolean \| undefined`	Indicates whether the DB engine version supports Aurora Limitless Database.
`SupportsLocalWriteForwarding`	`boolean \| undefined`	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
`SupportsLogExportsToCloudwatchLogs`	`boolean \| undefined`	Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
`SupportsParallelQuery`	`boolean \| undefined`	Indicates whether you can use Aurora parallel query with a specific DB engine version.
`SupportsReadReplica`	`boolean \| undefined`	Indicates whether the database engine version supports read replicas.
`TagList`	`Tag[] \| undefined`	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.
`ValidUpgradeTarget`	`UpgradeTarget[] \| undefined`	A list of engine versions that this database engine version can be upgraded to.

Throws

Name	Fault	Details
CreateCustomDBEngineVersionFault	client	An error occurred while trying to create the CEV.
CustomDBEngineVersionAlreadyExistsFault	client	A CEV with the specified name already exists.
CustomDBEngineVersionQuotaExceededFault	client	You have exceeded your CEV quota.
Ec2ImagePropertiesNotSupportedFault	client	The AMI configuration prerequisite has not been met.
KMSKeyNotAccessibleFault	client	An error occurred accessing an Amazon Web Services KMS key.
RDSServiceException		Base exception class for all service exceptions from RDS service.

Getting Started

References

CreateCustomDBEngineVersionCommand

Example Syntax

CreateCustomDBEngineVersionCommand Input

CreateCustomDBEngineVersionCommand Output

Throws

Table of Contents

Search