Creating a CEV
You can create a CEV using the Amazon Web Services Management Console or the Amazon CLI. Specify either the multitenant or non-multitenant architecture. For more information, see Multitenant architecture considerations.
Make sure that the Amazon S3 bucket containing your installation files is in the same Amazon Web Services Region as your CEV. Otherwise, the process to create a CEV fails.
Typically, creating a CEV takes about two hours. After the CEV is created, you can use it to create an RDS Custom DB instance. For more information, see Creating an RDS Custom for Oracle DB instance.
To create a CEV
Sign in to the Amazon Web Services Management Console and open the Amazon RDS console at https://console.amazonaws.cn/rds/
. -
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.
-
Choose Create custom engine version.
-
In Engine options, do the following:
-
For Engine type, choose Oracle.
-
For Architecture settings, optionally choose Multitenant architecture to create a Multitenant CEV, which uses the engine
custom-oracle-ee-cdb
. You can create an RDS Custom for Oracle CDB with a Multitenant CEV only. If you don't choose this option, your CEV is a non-CDB, which uses the enginecustom-oracle-ee
.Note
The architecture that you choose is a permanent characteristic of your CEV. You can't modify your CEV to use a different architecture later.
-
For Engine version, choose the major engine version.
-
-
In Version details, do the following:
-
Enter a valid name in Custom engine version name.
The name format is
. You can use 1–50 alphanumeric characters, underscores, dashes, and periods. For example, you might enter the namemajor-engine-version
.customized_string
19.cdb_cev1
. -
(Optional) Enter a description for your CEV.
-
-
In Installation media, do the following:
-
(Optional) For AMI ID, enter an AMI that you previously used to create a CEV. To obtain valid AMI IDs, use either of the following techniques:
-
In the console, choose Custom engine versions in the left navigation pane, and choose the name of a CEV. The AMI ID used by the CEV appears in the Configuration tab.
-
In the Amazon CLI, use the
describe-db-engine-versions
command. Search the output forImageID
.
If you don't enter an AMI ID, RDS Custom uses the most recent available AMI.
-
-
For S3 location of manifest files, enter the location of the Amazon S3 bucket that you specified in Step 3: Upload your installation files to Amazon S3. For example, enter
s3://my-custom-installation-files/806242271698/cev1/
. -
For CEV manifest, enter the JSON manifest that you created in Creating the CEV manifest.
-
-
In the KMS key section, select Enter a key ARN to list the available Amazon KMS keys. Then select your KMS key from the list.
An Amazon KMS key is required for RDS Custom. For more information, see Step 1: Create or reuse a symmetric encryption Amazon KMS key.
-
(Optional) Choose Add new tag to create a key-value pair for your CEV.
-
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 Amazon CLI, run the create-custom-db-engine-version command.
The following options are required:
-
--engine
, whereengine-type
engine-type
is eithercustom-oracle-ee-cdb
for a CDB orcustom-oracle-ee
for a non-CDB. You can create CDBs only from a CEV created withcustom-oracle-ee-cdb
. You can create non-CDBs only from a CEV created withcustom-oracle-ee
. -
--engine-version
major-engine-version
.customized_string
-
--kms-key-id
-
--manifest
ormanifest_string
--manifest file:
file_name
Newline characters aren't permitted in
. Make sure to escape double quotes (") in the JSON code by prefixing them with a backslash (\).manifest_string
The following example shows the
for 19c from Step 5: Prepare the CEV manifest. The example sets new values for the Oracle base, Oracle home, and the ID and name of the UNIX/Linux user and group. If you copy this string, remove all newline characters before pasting it into your command.manifest_string
"{\"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\"]\"installationParameters\":{ \"unixGroupName\":\"dba\", \ \"unixUname\":\"oracle\", \ \"oracleHome\":\"/home/oracle/oracle.19.0.0.0.ru-2020-04.rur-2020-04.r1.EE.1\", \ \"oracleBase\":\"/home/oracle/\"}}"
-
--database-installation-files-s3-bucket-name
s3-bucket-name
is the bucket name that you specified in Step 3: Upload your installation files to Amazon S3. The Amazon Web Services Region in which you runs3-bucket-name
create-custom-db-engine-version
must be the same Region as your Amazon S3 bucket.
You can also specify the following options:
-
--description
my-cev-description
-
--database-installation-files-s3-prefix
, whereprefix
is the folder name that you specified in Step 3: Upload your installation files to Amazon S3.prefix
-
--image-id
, whereami-id
is an AMI ID that want to reuse. To find valid IDs, run theami-id
describe-db-engine-versions
command, and then search the output forImageID
. By default, RDS Custom for Oracle uses the most recent available AMI.
The following example creates a Multitenant CEV named 19.cdb_cev1
.
The example reuses an existing AMI rather than use the latest available AMI. 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-cdb
\ --engine-version19.cdb_cev1
\ --database-installation-files-s3-bucket-nameus-east-1-123456789012-custom-installation-files
\ --database-installation-files-s3-prefix123456789012/cev1
\ --kms-key-idmy-kms-key
\ --description "test cev
" \ --manifestmanifest_string
\ --image-idami-012a345678901bcde
For Windows:
aws rds create-custom-db-engine-version ^ --engine
custom-oracle-ee-cdb
^ --engine-version19.cdb_cev1
^ --database-installation-files-s3-bucket-nameus-east-1-123456789012-custom-installation-files
^ --database-installation-files-s3-prefix123456789012/cev1
^ --kms-key-idmy-kms-key
^ --description "test cev
" ^ --manifestmanifest_string
^ --image-idami-012a345678901bcde
Get details about your CEV by using the describe-db-engine-versions
command.
aws rds describe-db-engine-versions \ --engine custom-oracle-ee-cdb \ --include-all
The following partial sample output shows the engine, parameter groups, manifest, and other information.
{ "DBEngineVersions": [ { "Engine": "custom-oracle-ee-cdb", "EngineVersion": "19.cdb_cev1", "DBParameterGroupFamily": "custom-oracle-ee-cdb-19", "DBEngineDescription": "Containerized Database for Oracle Custom EE", "DBEngineVersionDescription": "test cev", "Image": { "ImageId": "ami-012a345678901bcde", "Status": "active" }, "ValidUpgradeTarget": [], "SupportsLogExportsToCloudwatchLogs": false, "SupportsReadReplica": true, "SupportedFeatureNames": [], "Status": "available", "SupportsParallelQuery": false, "SupportsGlobalDatabases": false, "MajorEngineVersion": "19", "DatabaseInstallationFilesS3BucketName": "us-east-1-123456789012-custom-installation-files", "DatabaseInstallationFilesS3Prefix": "123456789012/cev1", "DBEngineVersionArn": "arn:aws:rds:us-east-1:123456789012:cev:custom-oracle-ee-cdb/19.cdb_cev1/abcd12e3-4f5g-67h8-i9j0-k1234l56m789", "KMSKeyId": "arn:aws:kms:us-east-1:732027699161:key/1ab2345c-6d78-9ef0-1gh2-3456i7j89k01", "CreateTime": "2023-03-07T19:47:58.131000+00:00", "TagList": [], "SupportsBabelfish": false, ...
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
, and includes details about the failure. For
example, the event prints missing files.major-engine-version.cev_name
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.