Creating a CEV - Amazon Relational Database Service

Creating a CEV

You can create a CEV using the AWS Management Console or the AWS CLI. Typically, creating a CEV takes about two hours.

You can then use the CEV to create an RDS Custom instance. Make sure that the Amazon S3 bucket containing your installation files is in the same AWS Region as your CEV. Otherwise, the process to create a CEV fails.

For more information, see Creating an RDS Custom for Oracle DB instance.

To create a CEV

  1. Sign in to the AWS Management Console and open the Amazon RDS console at https://console.aws.amazon.com/rds/.

  2. In the navigation pane, choose Custom engine versions.

    The Custom engine versions page shows all CEVs that currently exist. If you haven't created any CEVs, the page is empty.

  3. Choose Create custom engine version.

  4. For Engine type, choose Oracle.

  5. For Edition, choose Oracle Enterprise Edition. Oracle Enterprise Edition (Oracle RAC option) isn't supported.

  6. For Major version, choose the major engine version.

  7. In Version details, enter a valid name in Custom engine version name.

    The name format is major-engine-version.customized_string. You can use 1–50 alphanumeric characters, underscores, dashes, and periods. For example, you might enter the name 19.my_cev1.

    Optionally, enter a description for your CEV.

  8. For S3 location of manifest files, enter the location of the Amazon S3 bucket that you specified in Uploading your installation files to Amazon S3. For example, enter s3://my-custom-installation-files/806242271698/cev1/.

  9. In the RDS Custom encryption section, select Enter a key ARN to list the available AWS KMS keys.

    Then select your KMS key from the list. An AWS KMS key is required for RDS Custom. For more information, see Make sure that you have a symmetric encryption AWS KMS key.

  10. Choose Create custom engine version.

    If the CEV manifest has an invalid form, the console displays Error validating the CEV manifest. Fix the problems, and try again.

The Custom engine versions page appears. Your CEV is shown with the status Creating. The process to create the CEV takes approximately two hours.

To create a CEV by using the AWS CLI, run the create-custom-db-engine-version command.

The following options are required:

  • --engine custom-oracle-ee

  • --engine-version major-engine-version.customized_string

  • --kms-key-id

  • --manifest manifest_string

    Newline characters aren't permitted in manifest_string. Make sure to escape double quotes (") in the JSON code by prefixing them with a backslash (\).

    The following example shows the manifest_string for 19c from Preparing the CEV manifest. If you copy this string, remove all newline characters before pasting it into your command.

    "{\"mediaImportTemplateVersion\": \"2020-08-14\",\"databaseInstallationFileNames\": [\"V982063-01.zip\"],\"opatchFileNames\": [\"p6880880_190000_Linux-x86-64.zip\"],\"psuRuPatchFileNames\": [\"p32126828_190000_Linux-x86-64.zip\"],\"otherPatchFileNames\": [\"p29213893_1910000DBRU_Generic.zip\",\"p29782284_1910000DBRU_Generic.zip\",\"p28730253_190000_Linux-x86-64.zip\",\"p29374604_1910000DBRU_Linux-x86-64.zip\",\"p28852325_190000_Linux-x86-64.zip\",\"p29997937_190000_Linux-x86-64.zip\",\"p31335037_190000_Linux-x86-64.zip\",\"p31335142_190000_Generic.zip\"]}"

  • --database-installation-files-s3-bucket-name s3-bucket-name, where s3-bucket-name is the bucket name that you specified in Uploading your installation files to Amazon S3. The AWS Region in which you run create-custom-db-engine-version must be in the same AWS Region as the bucket.

You can also specify the following options:

The following example creates a CEV named 19.my_cev1. Make sure that the name of your CEV starts with the major engine version number.

For Linux, macOS, or Unix:

aws rds create-custom-db-engine-version \ --engine custom-oracle-ee \ --engine-version 19.my_cev1 \ --database-installation-files-s3-bucket-name my-custom-installation-files \ --database-installation-files-s3-prefix 123456789012/cev1 \ --kms-key-id my-kms-key \ --description "some text" \ --manifest manifest_string

For Windows:

aws rds create-custom-db-engine-version ^ --engine custom-oracle-ee ^ --engine-version 19.my_cev1 ^ --database-installation-files-s3-bucket-name s3://my-custom-installation-files ^ --database-installation-files-s3-prefix 123456789012/cev1 ^ --kms-key-id my-kms-key ^ --description "some text" ^ --manifest manifest_string

Get details about your CEV by using the describe-db-engine-versions command.

aws rds describe-db-engine-versions \ --engine custom-oracle-ee \ --include-all

The following partial output shows the engine, parameter groups, and other information.

"DBEngineVersions": [ { "Engine": "custom-oracle-ee", "Status": "available", "DBParameterGroupFamily": "custom-oracle-ee-19", "DBEngineVersionArn": "arn:aws:rds:us-west-2:<my-account-id>:cev:custom-oracle-ee/19.my_cev1/0a123b45-6c78-901d-23e4-5678f901fg23", "MajorEngineVersion": "19", "SupportsReadReplica": false, "SupportsLogExportsToCloudwatchLogs": false, "EngineVersion": "19.my_cev1", "DatabaseInstallationFilesS3BucketName": "my-custom-installation-files", "DBEngineDescription": "Oracle Database server EE for RDS Custom", "SupportedFeatureNames": [], "KMSKeyId": "arn:aws:kms:us-east-2:<your-account-id>:key/<my-kms-key-id>", "SupportsGlobalDatabases": false, "SupportsParallelQuery": false, "DatabaseInstallationFilesS3Prefix": "123456789012/cev1", "DBEngineVersionDescription": "some text", "ValidUpgradeTarget": [], "CreateTime": "2021-06-23T20:00:34.782Z" } ]

Failure to create a CEV

If the process to create a CEV fails, RDS Custom issues RDS-EVENT-0198 with the message Creation failed for custom engine version major-engine-version.cev_name, and includes details about the failure. For example, the event prints missing files.

You can't modify a failed CEV. You can only delete it, then try again to create a CEV after fixing the causes of the failure. For information about troubleshooting the reasons for CEV creation failure, see Troubleshooting custom engine version creation for RDS Custom for Oracle.