# Working with custom engine versions for Amazon RDS Custom for Oracle
**Note**
End of support notice: On March 31, 2027, AWS will end support for Amazon RDS Custom for Oracle. After March 31, 2027, you will no longer be able to access the RDS Custom for Oracle console or RDS Custom for Oracle resources. For more information, see [RDS Custom for Oracle end of support](RDS-Custom-for-Oracle-end-of-support.md).
A *custom engine version (CEV)* for Amazon RDS Custom for Oracle is a binary volume snapshot of a database engine and specific Amazon Machine Image (AMI). By default, RDS Custom for Oracle uses the latest available AMI managed by RDS Custom, but you can specify an AMI that was used in a previous CEV. You store your database installation files in Amazon S3. RDS Custom uses the installation files and the AMI to create your CEV for you.
**Topics**
+ [
# Preparing to create a CEV
](custom-cev.preparing.md)
+ [
# Creating a CEV
](custom-cev.create.md)
+ [
# Modifying CEV status
](custom-cev.modify.md)
+ [
# Viewing CEV details for Amazon RDS Custom for Oracle
](custom-cev.view.md)
+ [
# Deleting a CEV
](custom-cev.delete.md)
# Preparing to create a CEV
**Note**
End of support notice: On March 31, 2027, AWS will end support for Amazon RDS Custom for Oracle. After March 31, 2027, you will no longer be able to access the RDS Custom for Oracle console or RDS Custom for Oracle resources. For more information, see [RDS Custom for Oracle end of support](RDS-Custom-for-Oracle-end-of-support.md).
To create a CEV, access the installation files and patches that are stored in your Amazon S3 bucket for any of the following releases:
+ Oracle Database 19c
+ Oracle Database 18c
+ Oracle Database 12c Release 2 (12.2)
+ Oracle Database 12c Release 1 (12.1)
For example, you can use the April 2021 RU/RUR for Oracle Database 19c, or any valid combination of installation files and patches. For more information on the versions and Regions supported by RDS Custom for Oracle, see [RDS Custom with RDS for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.html#Concepts.RDS_Fea_Regions_DB-eng.Feature.RDSCustom.ora).
**Topics**
+ [
## Step 1 (Optional): Download the manifest templates
](#custom-cev.preparing.templates)
+ [
## Step 2: Download your database installation files and patches from Oracle Software Delivery Cloud
](#custom-cev.preparing.download)
+ [
## Step 3: Upload your installation files to Amazon S3
](#custom-cev.preparing.s3)
+ [
## Step 4 (Optional): Share your installation media in S3 across AWS accounts
](#custom-cev.preparing.accounts)
+ [
## Step 5: Prepare the CEV manifest
](#custom-cev.preparing.manifest)
+ [
## Step 6 (Optional): Validate the CEV manifest
](#custom-cev.preparing.validating)
+ [
## Step 7: Add necessary IAM permissions
](#custom-cev.preparing.iam)
## Step 1 (Optional): Download the manifest templates
A *CEV manifest* is a JSON document that includes the list of database installation .zip files for your CEV. To create a CEV, do the following:
1. Identify the Oracle database installation files that you want to include in your CEV.
1. Download the installation files.
1. Create a JSON manifest that lists the installation files.
RDS Custom for Oracle provides JSON manifest templates with our recommended .zip files for each supported Oracle Database release. For example, the following template is for the 19.17.0.0.0 RU.
```
{
"mediaImportTemplateVersion": "2020-08-14",
"databaseInstallationFileNames": [
"V982063-01.zip"
],
"opatchFileNames": [
"p6880880_190000_Linux-x86-64.zip"
],
"psuRuPatchFileNames": [
"p34419443_190000_Linux-x86-64.zip",
"p34411846_190000_Linux-x86-64.zip"
],
"otherPatchFileNames": [
"p28852325_190000_Linux-x86-64.zip",
"p29997937_190000_Linux-x86-64.zip",
"p31335037_190000_Linux-x86-64.zip",
"p32327201_190000_Linux-x86-64.zip",
"p33613829_190000_Linux-x86-64.zip",
"p34006614_190000_Linux-x86-64.zip",
"p34533061_190000_Linux-x86-64.zip",
"p34533150_190000_Generic.zip",
"p28730253_190000_Linux-x86-64.zip",
"p29213893_1917000DBRU_Generic.zip",
"p33125873_1917000DBRU_Linux-x86-64.zip",
"p34446152_1917000DBRU_Linux-x86-64.zip"
]
}
```
Each template has an associated readme that includes instructions for downloading the patches, URLs for the .zip files, and file checksums. You can use these templates as they are or modify them with your own patches. To review the templates, download [custom-oracle-manifest.zip](samples/custom-oracle-manifest.zip) to your local disk and then open it with a file archiving application. For more information, see [Step 5: Prepare the CEV manifest](#custom-cev.preparing.manifest).
## Step 2: Download your database installation files and patches from Oracle Software Delivery Cloud
When you have identified the installation files that you want for your CEV, download them to your local system. The Oracle Database installation files and patches are hosted on Oracle Software Delivery Cloud. Each CEV requires a base release, such as Oracle Database 19c or Oracle Database 12c Release 2 (12.2), and an optional list of patches.
**To download the database installation files for Oracle Database**
1. Go to [https://edelivery.oracle.com/](https://edelivery.oracle.com/) and sign in.
1. In the search box, enter **Oracle Database Enterprise Edition** or **Oracle Database Standard Edition 2** and choose **Search**.
1. Choose one of the following base releases:
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html)
1. Choose **Continue**.
1. Clear the **Download Queue** check box.
1. Choose the option that corresponds to your base release:
+ **Oracle Database 19.3.0.0.0 - Long Term Release**.
+ **Oracle Database 18.0.0.0.0**
+ **Oracle Database 12.2.0.1.0**.
+ **Oracle Database 12.1.0.2.0**.
1. Choose **Linux x86-64** in **Platform/Languages**.
1. Choose **Continue**, and then sign the Oracle License Agreement.
1. Choose the .zip file that corresponds to your database release:
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html)
1. Download your desired Oracle patches from `updates.oracle.com` or `support.oracle.com` to your local system. You can find the URLs for the patches in the following locations:
+ The readme files in the .zip file that you downloaded in [Step 1 (Optional): Download the manifest templates](#custom-cev.preparing.templates)
+ The patches listed in each Release Update (RU) in [Release notes for Amazon Relational Database Service (Amazon RDS) for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes)
## Step 3: Upload your installation files to Amazon S3
Upload your Oracle installation and patch files to Amazon S3 using the AWS CLI. The S3 bucket that contains your installation files must be in the same AWS Region as your CEV.
Examples in this section use the following placeholders:
+ `install-or-patch-file.zip` – Oracle installation media file. For example, p32126828\$1190000\$1Linux-x86-64.zip is a patch.
+ `amzn-s3-demo-destination-bucket` – Your Amazon S3 bucket designated for your uploaded installation files.
+ `123456789012/cev1` – An optional prefix in your Amazon S3 bucket.
+ `amzn-s3-demo-source-bucket` – An Amazon S3 bucket where you can optionally stage files.
**Topics**
+ [
### Step 3a: Verify that your S3 bucket is in the correct AWS Region
](#custom-cev.preparing.s3.verify-region)
+ [
### Step 3b: Make sure that your S3 bucket policy has the correct permissions
](#custom-cev.preparing.s3.verify-policy)
+ [
### Step 3c: Upload your files using the cp or sync commands
](#custom-cev.preparing.s3.upload)
+ [
### Step 3d: List the files in your S3 bucket
](#custom-cev.preparing.s3.list)
### Step 3a: Verify that your S3 bucket is in the correct AWS Region
Verify that your S3 bucket is in the AWS Region where you plan to run the `create-custom-db-engine-version` command.
```
aws s3api get-bucket-location --bucket amzn-s3-demo-destination-bucket
```
### Step 3b: Make sure that your S3 bucket policy has the correct permissions
You can create a CEV from scratch or from a source CEV. If you plan to create new CEV from source CEVs, make sure that your S3 bucket policy has the correct permissions:
1. Identify the S3 bucket reserved by RDS Custom. The bucket name has the format `do-not-delete-rds-custom-account-region-string`. For example, the bucket might be named `do-not-delete-rds-custom-123456789012-us-east-1-abc123EXAMPLE`.
1. Make sure that the following permission is appended to your S3 bucket policy. Replace `do-not-delete-rds-custom-123456789012-us-east-1-abc123EXAMPLE` with the name of your bucket.
```
{
"Sid": "AWSRDSCustomForOracleCustomEngineVersionGetObject",
"Effect": "Allow",
"Principal": {
"Service": "custom.rds.amazonaws.com"
},
"Action": [
"s3:GetObject",
"s3:GetObjectTagging"
],
"Resource": "arn:aws:s3:::do-not-delete-rds-custom-123456789012-us-east-1-abc123EXAMPLE/CustomEngineVersions/*"
}, ...
```
### Step 3c: Upload your files using the cp or sync commands
Choose either of the following options:
+ Use `aws s3 cp` to upload a single .zip file.
Upload each installation .zip file separately. Don't combine the .zip files into a single .zip file.
+ Use `aws s3 sync` to upload a directory.
**Example**
The following example uploads `install-or-patch-file.zip` to the `123456789012/cev1` folder in the RDS Custom Amazon S3 bucket. Run a separate `aws s3` command for each .zip that you want to upload.
For Linux, macOS, or Unix:
```
1. aws s3 cp install-or-patch-file.zip \
2. s3://amzn-s3-demo-destination-bucket/123456789012/cev1/
```
For Windows:
```
1. aws s3 cp install-or-patch-file.zip ^
2. s3://amzn-s3-demo-destination-bucket/123456789012/cev1/
```
**Example**
The following example uploads the files in your local *cev1* folder to the *123456789012/cev1* folder in your Amazon S3 bucket.
For Linux, macOS, or Unix:
```
aws s3 sync cev1 \
s3://amzn-s3-demo-destination-bucket/123456789012/cev1/
```
For Windows:
```
aws s3 sync cev1 ^
s3://amzn-s3-demo-destination-bucket/123456789012/cev1/
```
**Example**
The following example uploads all files in `amzn-s3-demo-source-bucket` to the **`123456789012/cev1`** folder in your Amazon S3 bucket.
For Linux, macOS, or Unix:
```
aws s3 sync s3://amzn-s3-demo-source-bucket/ \
s3://amzn-s3-demo-destination-bucket/123456789012/cev1/
```
For Windows:
```
aws s3 sync s3://amzn-s3-demo-source-bucket/ ^
s3://amzn-s3-demo-destination-bucket/123456789012/cev1/
```
### Step 3d: List the files in your S3 bucket
The following example uses the `s3 ls` command to list the files in your RDS Custom Amazon S3 bucket.
```
aws s3 ls \
s3://amzn-s3-demo-destination-bucket/123456789012/cev1/
```
## Step 4 (Optional): Share your installation media in S3 across AWS accounts
For the purposes of this section, the Amazon S3 bucket that contains your uploaded Oracle installation files is your *media bucket*. Your organization might use multiple AWS accounts in an AWS Region. If so, you might want to use one AWS account to populate your media bucket and a different AWS account to create CEVs. If you don't intend to share your media bucket, skip to the next section.
This section assumes the following:
+ You can access the account that created your media bucket and a different account in which you intend to create CEVs.
+ You intend to create CEVs in only one AWS Region. If you intend to use multiple Regions, create a media bucket in each Region.
+ You're using the CLI. If you're using the Amazon S3 console, adapt the following steps.
**To configure your media bucket for sharing across AWS accounts**
1. Log in to the AWS account that contains the S3 bucket into which you uploaded your installation media.
1. Start with either a blank JSON policy template or an existing policy that you can adapt.
The following command retrieves an existing policy and saves it as *my-policy.json*. In this example, the S3 bucket containing your installation files is named *amzn-s3-demo-bucket*.
```
aws s3api get-bucket-policy \
--bucket amzn-s3-demo-bucket \
--query Policy \
--output text > my-policy.json
```
1. Edit the media bucket permissions as follows:
+ In the `Resource` element of your template, specify the S3 bucket into which you uploaded your Oracle Database installation files.
+ In the `Principal` element, specify the ARNs for all AWS accounts that you intend to use to create CEVs. You can add the root, a user, or a role to the S3 bucket allow list. For more information, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in the *AWS Identity and Access Management User Guide*.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "GrantAccountsAccess",
"Effect": "Allow",
"Principal": {
"AWS": [
"arn:aws:iam::111122223333:root",
"arn:aws:iam::444455556666:user/user-name-with-path",
"arn:aws:iam::123456789012:role/role-name-with-path"
]
},
"Action": [
"s3:GetObject",
"s3:GetObjectAcl",
"s3:GetObjectTagging",
"s3:ListBucket",
"s3:GetBucketLocation"
],
"Resource": [
"arn:aws:s3:::amzn-s3-demo-bucket",
"arn:aws:s3:::amzn-s3-demo-bucket/*"
]
}
]
}
```
------
1. Attach the policy to your media bucket.
In the following example, *amzn-s3-demo-bucket* is the name of the S3 bucket that contains your installation files, and *my-policy.json* is the name of your JSON file.
```
aws s3api put-bucket-policy \
--bucket amzn-s3-demo-bucket \
--policy file://my-policy.json
```
1. Log in to an AWS account in which you intend to create CEVs.
1. Verify that this account can access the media bucket in the AWS account that created it.
```
aws s3 ls --query "Buckets[].Name"
```
For more information, see [aws s3 ls](https://docs.aws.amazon.com/cli/latest/reference/s3/ls.html) in the *AWS CLI Command Reference*.
1. Create a CEV by following the steps in [Creating a CEV](custom-cev.create.md).
## Step 5: Prepare the CEV manifest
A CEV manifest is a JSON document that includes the following:
+ (Required) The list of installation .zip files that you uploaded to Amazon S3. RDS Custom applies the patches in the order in which they're listed in the manifest.
+ (Optional) Installation parameters that set nondefault values for the Oracle base, Oracle home, and the ID and name of the UNIX/Linux user and group. Be aware that you can’t modify the installation parameters for an existing CEV or an existing DB instance. You also can’t upgrade from one CEV to another CEV when the installation parameters have different settings.
For sample CEV manifests, see the JSON templates that you downloaded in [Step 1 (Optional): Download the manifest templates](#custom-cev.preparing.templates). You can also review the samples in [CEV manifest examples](#custom-cev.preparing.manifest.examples).
**Topics**
+ [
### JSON fields in the CEV manifest
](#custom-cev.preparing.manifest.fields)
+ [
### Creating the CEV manifest
](#custom-cev.preparing.manifest.creating)
+ [
### CEV manifest examples
](#custom-cev.preparing.manifest.examples)
### JSON fields in the CEV manifest
The following table describes the JSON fields in the manifest.
| JSON field | Description |
| --- | --- |
| `MediaImportTemplateVersion` | Version of the CEV manifest. The date is in the format `YYYY-MM-DD`. |
| `databaseInstallationFileNames` | Ordered list of installation files for the database. |
| `opatchFileNames` | Ordered list of OPatch installers used for the Oracle DB engine. Only one value is valid. Values for `opatchFileNames` must start with `p6880880_`. |
| `psuRuPatchFileNames` | The PSU and RU patches for this database. If you include `psuRuPatchFileNames`, `opatchFileNames` is required. Values for `opatchFileNames` must start with `p6880880_`. |
| `OtherPatchFileNames` | The patches that aren't in the list of PSU and RU patches. RDS Custom applies these patches after applying the PSU and RU patches. If you include `OtherPatchFileNames`, `opatchFileNames` is required. Values for `opatchFileNames` must start with `p6880880_`. |
| `installationParameters` | Nondefault settings for the Oracle base, Oracle home, and the ID and name of the UNIX/Linux user and group. You can set the following parameters: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html) |
Each Oracle Database release has a different list of supported installation files. When you create your CEV manifest, make sure to specify only files that are supported by RDS Custom for Oracle. Otherwise, CEV creation fails with an error. All patches listed in [Release notes for Amazon Relational Database Service (Amazon RDS) for Oracle](https://docs.aws.amazon.com/AmazonRDS/latest/OracleReleaseNotes) are supported.
### Creating the CEV manifest
**To create a CEV manifest**
1. List all installation files that you plan to apply, in the order that you want to apply them.
1. Correlate the installation files with the JSON fields described in [JSON fields in the CEV manifest](#custom-cev.preparing.manifest.fields).
1. Do either of the following:
+ Create the CEV manifest as a JSON text file.
+ Edit the CEV manifest template when you create the CEV in the console. For more information, see [Creating a CEV](custom-cev.create.md).
### CEV manifest examples
The following examples show CEV manifest files for different Oracle Database releases. If you include a JSON field in your manifest, make sure that it isn't empty. For example, the following CEV manifest isn't valid because `otherPatchFileNames` is empty.
```
{
"mediaImportTemplateVersion": "2020-08-14",
"databaseInstallationFileNames": [
"V982063-01.zip"
],
"opatchFileNames": [
"p6880880_190000_Linux-x86-64.zip"
],
"psuRuPatchFileNames": [
"p32126828_190000_Linux-x86-64.zip"
],
"otherPatchFileNames": [
]
}
```
**Topics**
+ [Sample CEV manifest for Oracle Database 12c Release 1 (12.1)](#oracle-cev-manifest-12.1)
+ [Sample CEV manifest for Oracle Database 12c Release 2 (12.2)](#oracle-cev-manifest-12.2)
+ [Sample CEV manifest for Oracle Database 18c](#oracle-cev-manifest-18c)
+ [Sample CEV manifest for Oracle Database 19c](#oracle-cev-manifest-19c)
**Example Sample CEV manifest for Oracle Database 12c Release 1 (12.1)**
In the following example for the July 2021 PSU for Oracle Database 12c Release 1 (12.1), RDS Custom applies the patches in the order specified. Thus, RDS Custom applies p32768233, then p32876425, then p18759211, and so on. The example sets new values for the UNIX user and group, and the Oracle home and Oracle base.
```
{
"mediaImportTemplateVersion":"2020-08-14",
"databaseInstallationFileNames":[
"V46095-01_1of2.zip",
"V46095-01_2of2.zip"
],
"opatchFileNames":[
"p6880880_121010_Linux-x86-64.zip"
],
"psuRuPatchFileNames":[
"p32768233_121020_Linux-x86-64.zip"
],
"otherPatchFileNames":[
"p32876425_121020_Linux-x86-64.zip",
"p18759211_121020_Linux-x86-64.zip",
"p19396455_121020_Linux-x86-64.zip",
"p20875898_121020_Linux-x86-64.zip",
"p22037014_121020_Linux-x86-64.zip",
"p22873635_121020_Linux-x86-64.zip",
"p23614158_121020_Linux-x86-64.zip",
"p24701840_121020_Linux-x86-64.zip",
"p25881255_121020_Linux-x86-64.zip",
"p27015449_121020_Linux-x86-64.zip",
"p28125601_121020_Linux-x86-64.zip",
"p28852325_121020_Linux-x86-64.zip",
"p29997937_121020_Linux-x86-64.zip",
"p31335037_121020_Linux-x86-64.zip",
"p32327201_121020_Linux-x86-64.zip",
"p32327208_121020_Generic.zip",
"p17969866_12102210119_Linux-x86-64.zip",
"p20394750_12102210119_Linux-x86-64.zip",
"p24835919_121020_Linux-x86-64.zip",
"p23262847_12102201020_Linux-x86-64.zip",
"p21171382_12102201020_Generic.zip",
"p21091901_12102210720_Linux-x86-64.zip",
"p33013352_12102210720_Linux-x86-64.zip",
"p25031502_12102210720_Linux-x86-64.zip",
"p23711335_12102191015_Generic.zip",
"p19504946_121020_Linux-x86-64.zip"
],
"installationParameters": {
"unixGroupName": "dba",
"unixGroupId": 12345,
"unixUname": "oracle",
"unixUid": 12345,
"oracleHome": "/home/oracle/oracle.12.1.0.2",
"oracleBase": "/home/oracle"
}
}
```
**Example Sample CEV manifest for Oracle Database 12c Release 2 (12.2)**
In following example for the October 2021 PSU for Oracle Database 12c Release 2 (12.2), RDS Custom applies p33261817, then p33192662, then p29213893, and so on. The example sets new values for the UNIX user and group, and the Oracle home and Oracle base.
```
{
"mediaImportTemplateVersion":"2020-08-14",
"databaseInstallationFileNames":[
"V839960-01.zip"
],
"opatchFileNames":[
"p6880880_122010_Linux-x86-64.zip"
],
"psuRuPatchFileNames":[
"p33261817_122010_Linux-x86-64.zip"
],
"otherPatchFileNames":[
"p33192662_122010_Linux-x86-64.zip",
"p29213893_122010_Generic.zip",
"p28730253_122010_Linux-x86-64.zip",
"p26352615_12201211019DBOCT2021RU_Linux-x86-64.zip",
"p23614158_122010_Linux-x86-64.zip",
"p24701840_122010_Linux-x86-64.zip",
"p25173124_122010_Linux-x86-64.zip",
"p25881255_122010_Linux-x86-64.zip",
"p27015449_122010_Linux-x86-64.zip",
"p28125601_122010_Linux-x86-64.zip",
"p28852325_122010_Linux-x86-64.zip",
"p29997937_122010_Linux-x86-64.zip",
"p31335037_122010_Linux-x86-64.zip",
"p32327201_122010_Linux-x86-64.zip",
"p32327208_122010_Generic.zip"
],
"installationParameters": {
"unixGroupName": "dba",
"unixGroupId": 12345,
"unixUname": "oracle",
"unixUid": 12345,
"oracleHome": "/home/oracle/oracle.12.2.0.1",
"oracleBase": "/home/oracle"
}
}
```
**Example Sample CEV manifest for Oracle Database 18c**
In following example for the October 2021 PSU for Oracle Database 18c, RDS Custom applies p32126855, then p28730253, then p27539475, and so on. The example sets new values for the UNIX user and group, and the Oracle home and Oracle base.
```
{
"mediaImportTemplateVersion":"2020-08-14",
"databaseInstallationFileNames":[
"V978967-01.zip"
],
"opatchFileNames":[
"p6880880_180000_Linux-x86-64.zip"
],
"psuRuPatchFileNames":[
"p32126855_180000_Linux-x86-64.zip"
],
"otherPatchFileNames":[
"p28730253_180000_Linux-x86-64.zip",
"p27539475_1813000DBRU_Linux-x86-64.zip",
"p29213893_180000_Generic.zip",
"p29374604_1813000DBRU_Linux-x86-64.zip",
"p29782284_180000_Generic.zip",
"p28125601_180000_Linux-x86-64.zip",
"p28852325_180000_Linux-x86-64.zip",
"p29997937_180000_Linux-x86-64.zip",
"p31335037_180000_Linux-x86-64.zip",
"p31335142_180000_Generic.zip"
]
"installationParameters": {
"unixGroupName": "dba",
"unixGroupId": 12345,
"unixUname": "oracle",
"unixUid": 12345,
"oracleHome": "/home/oracle/18.0.0.0.ru-2020-10.rur-2020-10.r1",
"oracleBase": "/home/oracle/"
}
}
```
**Example Sample CEV manifest for Oracle Database 19c**
In the following example for Oracle Database 19c, RDS Custom applies p32126828, then p29213893, then p29782284, and so on. The example sets new values for the UNIX user and group, and the Oracle home and Oracle base.
```
{
"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",
"unixGroupId": 12345,
"unixUname": "oracle",
"unixUid": 12345,
"oracleHome": "/home/oracle/oracle.19.0.0.0.ru-2020-04.rur-2020-04.r1.EE.1",
"oracleBase": "/home/oracle"
}
}
```
## Step 6 (Optional): Validate the CEV manifest
Optionally, verify that manifest is a valid JSON file by running the `json.tool` Python script. For example, if you change into the directory containing a CEV manifest named `manifest.json`, run the following command.
```
python -m json.tool < manifest.json
```
## Step 7: Add necessary IAM permissions
Make sure that the IAM principal that creates the CEV has the necessary policies described in [Step 5: Grant required permissions to your IAM user or role](custom-setup-orcl.md#custom-setup-orcl.iam-user).
# Creating a CEV
**Note**
End of support notice: On March 31, 2027, AWS will end support for Amazon RDS Custom for Oracle. After March 31, 2027, you will no longer be able to access the RDS Custom for Oracle console or RDS Custom for Oracle resources. For more information, see [RDS Custom for Oracle end of support](RDS-Custom-for-Oracle-end-of-support.md).
You can create a CEV using the AWS Management Console or the AWS CLI. Specify either the multitenant or non-multitenant architecture. For more information, see [Multitenant architecture considerations](custom-creating.md#custom-creating.overview).
Typically, creating a CEV takes about two hours. After you have created the CEV, you can use it to create or upgrade an RDS Custom DB instance. For more information, see [Creating an RDS Custom for Oracle DB instance](custom-creating.md#custom-creating.create) and [Upgrading an RDS Custom for Oracle DB instance](custom-upgrading-modify.md).
**Note**
If your DB instance currently uses Oracle Linux 7.9, create a new CEV that uses the latest AMI, which uses Oracle Linux 8. Then modify your instance to use the new CEV.
Note the following requirements and limitations for creating a CEV:
+ The Amazon S3 bucket containing your installation files must be in the same AWS Region as your CEV. Otherwise, the creation process fails.
+ The CEV name must be in the format `major-engine-version.customized_string`, as in `19.cdb_cev1`.
+ The CEV name must contain 1–50 alphanumeric characters, underscores, dashes, or periods.
+ The CEV name can't contain consecutive periods, as in `19..cdb_cev1`.
## Console
**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/](https://console.aws.amazon.com/rds/).
1. 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.
1. Choose **Create custom engine version**.
1. In **Engine options**, do the following:
1. For **Engine type**, choose **Oracle**.
1. For **Architecture settings**, optionally choose **Multitenant architecture** to create an Oracle multitenant CEV, which uses the DB engine `custom-oracle-ee-cdb` or `custom-oracle-se2-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 engine `custom-oracle-ee` or `custom-oracle-se2`.
**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.
1. Choose either of the following options:
+ **Create new CEV** – Create a CEV from scratch. In this case, you must specify a JSON manifest specifying the database binaries.
+ **Create CEV from source** – In **Specify the CEV that you want to copy**, choose an existing CEV to use as the source CEV. In this case, you can specify a new Amazon Machine Image (AMI), but you can't specify different database binaries.
1. For **Engine version**, choose the major engine version.
1. In **Version details**, do the following:
1. Enter a valid name in **Custom engine version name**. For example, you might enter the name **19.cdb\$1cev1**.
1. (Optional) Enter a description for your CEV.
1. In **Installation media**, do the following:
1. (Optional) For **AMI ID**, either leave the field blank to use the latest service-provided AMI, or 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 AWS CLI, use the `describe-db-engine-versions` command. Search the output for `ImageID`.
1. 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](custom-cev.preparing.md#custom-cev.preparing.s3). For example, enter **s3://my-custom-installation-files/123456789012/cev1/**.
**Note**
The AWS Region in which you create the CEV must be in the same Region as the S3 bucket.
1. (Create new CEV only) For **CEV manifest**, enter the JSON manifest that you created in [Creating the CEV manifest](custom-cev.preparing.md#custom-cev.preparing.manifest.creating).
1. In the **KMS key** 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 [Step 1: Create or reuse a symmetric encryption AWS KMS key](custom-setup-orcl.md#custom-setup-orcl.cmk).
1. (Optional) Choose **Add new tag** to create a key-value pair for your CEV.
1. Choose **Create custom engine version**.
If the JSON manifest is in an invalid format, 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 a CEV takes approximately two hours.
## AWS CLI
To create a CEV by using the AWS CLI, run the [create-custom-db-engine-version](https://docs.aws.amazon.com/cli/latest/reference/rds/create-custom-db-engine-version.html) command.
The following options are required:
+ `--engine` – Specify the engine type. For a CDB, specify either `custom-oracle-ee-cdb` or `custom-oracle-se2-cdb`. For a non-CDB, specify either `custom-oracle-ee` or `custom-oracle-se2`. You can create CDBs only from a CEV created with `custom-oracle-ee-cdb` or `custom-oracle-se2-cdb`. You can create non-CDBs only from a CEV created with `custom-oracle-ee` or `custom-oracle-se2`.
+ `--engine-version` – Specify the engine version. The format is *major-engine-version*.*customized\$1string*. The CEV name must contain 1–50 alphanumeric characters, underscores, dashes, or periods. The CEV name can't contain consecutive periods, as in `19..cdb_cev1`.
+ `--kms-key-id` – Specify an AWS KMS key.
+ `--manifest` – Specify either `manifest_json_string` or `--manifest file:file_name`. Newline characters aren't permitted in `manifest_json_string`. Make sure to escape double quotes (") in the JSON code by prefixing them with a backslash (\$1).
The following example shows the `manifest_json_string` for 19c from [Step 5: Prepare the CEV manifest](custom-cev.preparing.md#custom-cev.preparing.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 you paste 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\"]\"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` – Specify the same bucket name that you specified in [Step 3: Upload your installation files to Amazon S3](custom-cev.preparing.md#custom-cev.preparing.s3). The AWS Region in which you run `create-custom-db-engine-version` must be the same Region as your Amazon S3 bucket.
You can also specify the following options:
+ `--description` – Specify a description of your CEV.
+ `--database-installation-files-s3-prefix` – Specify the folder name that you specified in [Step 3: Upload your installation files to Amazon S3](custom-cev.preparing.md#custom-cev.preparing.s3).
+ `--image-id` – Specify an AMI ID that want to reuse. To find valid IDs, run the `describe-db-engine-versions` command, and then search the output for `ImageID`. By default, RDS Custom for Oracle uses the most recent available AMI.
The following example creates an Oracle 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.
**Example**
For Linux, macOS, or Unix:
```
1. aws rds create-custom-db-engine-version \
2. --engine custom-oracle-se2-cdb \
3. --engine-version 19.cdb_cev1 \
4. --database-installation-files-s3-bucket-name us-east-1-123456789012-custom-installation-files \
5. --database-installation-files-s3-prefix 123456789012/cev1 \
6. --kms-key-id my-kms-key \
7. --description "test cev" \
8. --manifest manifest_string \
9. --image-id ami-012a345678901bcde
```
For Windows:
```
1. aws rds create-custom-db-engine-version ^
2. --engine custom-oracle-se2-cdb ^
3. --engine-version 19.cdb_cev1 ^
4. --database-installation-files-s3-bucket-name us-east-1-123456789012-custom-installation-files ^
5. --database-installation-files-s3-prefix 123456789012/cev1 ^
6. --kms-key-id my-kms-key ^
7. --description "test cev" ^
8. --manifest manifest_string ^
9. --image-id ami-012a345678901bcde
```
**Example**
Get details about your CEV by using the `describe-db-engine-versions` command.
```
1. aws rds describe-db-engine-versions \
2. --engine custom-oracle-se2-cdb \
3. --include-all
```
The following partial sample output shows the engine, parameter groups, manifest, and other information.
```
1. {
2. "DBEngineVersions": [
3. {
4. "Engine": "custom-oracle-se2-cdb",
5. "EngineVersion": "19.cdb_cev1",
6. "DBParameterGroupFamily": "custom-oracle-se2-cdb-19",
7. "DBEngineDescription": "Containerized Database for Oracle Custom SE2",
8. "DBEngineVersionDescription": "test cev",
9. "Image": {
10. "ImageId": "ami-012a345678901bcde",
11. "Status": "active"
12. },
13. "ValidUpgradeTarget": [],
14. "SupportsLogExportsToCloudwatchLogs": false,
15. "SupportsReadReplica": true,
16. "SupportedFeatureNames": [],
17. "Status": "available",
18. "SupportsParallelQuery": false,
19. "SupportsGlobalDatabases": false,
20. "MajorEngineVersion": "19",
21. "DatabaseInstallationFilesS3BucketName": "us-east-1-123456789012-custom-installation-files",
22. "DatabaseInstallationFilesS3Prefix": "123456789012/cev1",
23. "DBEngineVersionArn": "arn:aws:rds:us-east-1:123456789012:cev:custom-oracle-se2-cdb/19.cdb_cev1/abcd12e3-4f5g-67h8-i9j0-k1234l56m789",
24. "KMSKeyId": "arn:aws:kms:us-east-1:732027699161:key/1ab2345c-6d78-9ef0-1gh2-3456i7j89k01",
25. "CreateTime": "2023-03-07T19:47:58.131000+00:00",
26. "TagList": [],
27. "SupportsBabelfish": false,
28. ...
```
## 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](custom-troubleshooting.md#custom-troubleshooting.cev).
# Modifying CEV status
**Note**
End of support notice: On March 31, 2027, AWS will end support for Amazon RDS Custom for Oracle. After March 31, 2027, you will no longer be able to access the RDS Custom for Oracle console or RDS Custom for Oracle resources. For more information, see [RDS Custom for Oracle end of support](RDS-Custom-for-Oracle-end-of-support.md).
You can modify a CEV using the AWS Management Console or the AWS CLI. You can modify the CEV description or its availability status. Your CEV has one of the following status values:
+ `available` – You can use this CEV to create a new RDS Custom DB instance or upgrade a DB instance. This is the default status for a newly created CEV.
+ `inactive` – You can't create or upgrade an RDS Custom instance with this CEV. You can't restore a DB snapshot to create a new RDS Custom DB instance with this CEV.
You can change the CEV from any supported status to any other supported status. You might change status to prevent the accidental use of a CEV or make a discontinued CEV eligible for use again. For example, you might change the status of your CEV from `available` to `inactive`, and from `inactive` back to `available`.
## Console
**To modify a CEV**
1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console.aws.amazon.com/rds/](https://console.aws.amazon.com/rds/).
1. In the navigation pane, choose **Custom engine versions**.
1. Choose a CEV whose description or status you want to modify.
1. For **Actions**, choose **Modify**.
1. Make any of the following changes:
+ For **CEV status settings**, choose a new availability status.
+ For **Version description**, enter a new description.
1. Choose **Modify CEV**.
If the CEV is in use, the console displays **You can't modify the CEV status**. Fix the problems, and try again.
The **Custom engine versions** page appears.
## AWS CLI
To modify a CEV by using the AWS CLI, run the [modify-custom-db-engine-version](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-custom-db-engine-version.html) command. You can find CEVs to modify by running the [describe-db-engine-versions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html) command.
The following options are required:
+ `--engine engine-type`, where *engine-type* is `custom-oracle-ee`, `custom-oracle-se2`, `custom-oracle-ee-cdb`, or `custom-oracle-se2-cdb`
+ `--engine-version cev`, where *`cev`* is the name of the custom engine version that you want to modify
+ `--status`` status`, where *`status`* is the availability status that you want to assign to the CEV
The following example changes a CEV named `19.my_cev1` from its current status to `inactive`.
**Example**
For Linux, macOS, or Unix:
```
1. aws rds modify-custom-db-engine-version \
2. --engine custom-oracle-se2 \
3. --engine-version 19.my_cev1 \
4. --status inactive
```
For Windows:
```
1. aws rds modify-custom-db-engine-version ^
2. --engine custom-oracle-se2 ^
3. --engine-version 19.my_cev1 ^
4. --status inactive
```
# Viewing CEV details for Amazon RDS Custom for Oracle
**Note**
End of support notice: On March 31, 2027, AWS will end support for Amazon RDS Custom for Oracle. After March 31, 2027, you will no longer be able to access the RDS Custom for Oracle console or RDS Custom for Oracle resources. For more information, see [RDS Custom for Oracle end of support](RDS-Custom-for-Oracle-end-of-support.md).
You can view details about your CEV manifest and the command used to create your CEV by using the AWS Management Console or the AWS CLI.
## Console
**To view CEV details**
1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console.aws.amazon.com/rds/](https://console.aws.amazon.com/rds/).
1. 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.
1. Choose the name of the CEV that you want to view.
1. Choose **Configuration** to view the installation parameters specified in your manifest.
![\[View the installation parameters for a CEV.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/cev-configuration-tab.png)
1. Choose **Manifest** to view the installation parameters specified in the `--manifest` option of the `create-custom-db-engine-version` command. You can copy this text, replace values as needed, and use them in a new command.
![\[View the command used to create the CEV.\]](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/images/cev-manifest-tab.png)
## AWS CLI
To view details about a CEV by using the AWS CLI, run the [describe-db-engine-versions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html) command.
The following options are required:
+ `--engine engine-type`, where *engine-type* is `custom-oracle-ee`, `custom-oracle-se2`, `custom-oracle-ee-cdb`, or `custom-oracle-se2-cdb`
+ `--engine-version major-engine-version.customized_string`
The following example creates a non-CDB CEV that uses Enterprise Edition. The CEV name `19.my_cev1` starts with the major engine version number, which is required.
**Example**
For Linux, macOS, or Unix:
```
1. aws rds describe-db-engine-versions \
2. --engine custom-oracle-ee \
3. --engine-version 19.my_cev1
```
For Windows:
```
1. aws rds describe-db-engine-versions ^
2. --engine custom-oracle-ee ^
3. --engine-version 19.my_cev1
```
The following partial sample output shows the engine, parameter groups, manifest, and other information.
```
1. "DBEngineVersions": [
2. {
3. "Engine": "custom-oracle-ee",
4. "MajorEngineVersion": "19",
5. "EngineVersion": "19.my_cev1",
6. "DatabaseInstallationFilesS3BucketName": "us-east-1-123456789012-cev-customer-installation-files",
7. "DatabaseInstallationFilesS3Prefix": "123456789012/cev1",
8. "CustomDBEngineVersionManifest": "{\n\"mediaImportTemplateVersion\": \"2020-08-14\",\n\"databaseInstallationFileNames\": [\n\"V982063-01.zip\"\n],\n\"installationParameters\": {\n\"oracleBase\":\"/tmp\",\n\"oracleHome\":\"/tmp/Oracle\"\n},\n\"opatchFileNames\": [\n\"p6880880_190000_Linux-x86-64.zip\"\n],\n\"psuRuPatchFileNames\": [\n\"p32126828_190000_Linux-x86-64.zip\"\n],\n\"otherPatchFileNames\": [\n\"p29213893_1910000DBRU_Generic.zip\",\n\"p29782284_1910000DBRU_Generic.zip\",\n\"p28730253_190000_Linux-x86-64.zip\",\n\"p29374604_1910000DBRU_Linux-x86-64.zip\",\n\"p28852325_190000_Linux-x86-64.zip\",\n\"p29997937_190000_Linux-x86-64.zip\",\n\"p31335037_190000_Linux-x86-64.zip\",\n\"p31335142_190000_Generic.zip\"\n]\n}\n",
9. "DBParameterGroupFamily": "custom-oracle-ee-19",
10. "DBEngineDescription": "Oracle Database server EE for RDS Custom",
11. "DBEngineVersionArn": "arn:aws:rds:us-west-2:123456789012:cev:custom-oracle-ee/19.my_cev1/0a123b45-6c78-901d-23e4-5678f901fg23",
12. "DBEngineVersionDescription": "test",
13. "KMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/ab1c2de3-f4g5-6789-h012-h3ijk4567l89",
14. "CreateTime": "2022-11-18T09:17:07.693000+00:00",
15. "ValidUpgradeTarget": [
16. {
17. "Engine": "custom-oracle-ee",
18. "EngineVersion": "19.cev.2021-01.09",
19. "Description": "test",
20. "AutoUpgrade": false,
21. "IsMajorVersionUpgrade": false
22. }
23. ]
```
# Deleting a CEV
**Note**
End of support notice: On March 31, 2027, AWS will end support for Amazon RDS Custom for Oracle. After March 31, 2027, you will no longer be able to access the RDS Custom for Oracle console or RDS Custom for Oracle resources. For more information, see [RDS Custom for Oracle end of support](RDS-Custom-for-Oracle-end-of-support.md).
You can delete a CEV using the AWS Management Console or the AWS CLI. Typically, deletion takes a few minutes.
To delete a CEV, it can't be in use by any of the following:
+ An RDS Custom DB instance
+ A snapshot of an RDS Custom DB instance
+ An automated backup of your RDS Custom DB instance
## Console
**To delete a CEV**
1. Sign in to the AWS Management Console and open the Amazon RDS console at [https://console.aws.amazon.com/rds/](https://console.aws.amazon.com/rds/).
1. In the navigation pane, choose **Custom engine versions**.
1. Choose a CEV whose description or status you want to delete.
1. For **Actions**, choose **Delete**.
The **Delete *cev\$1name*?** dialog box appears.
1. Enter **delete me**, and then choose **Delete**.
In the **Custom engine versions** page, the banner shows that your CEV is being deleted.
## AWS CLI
To delete a CEV by using the AWS CLI, run the [delete-custom-db-engine-version](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-custom-db-engine-version.html) command.
The following options are required:
+ `--engine engine-type`, where *engine-type* is `custom-oracle-ee`, `custom-oracle-se2`, `custom-oracle-ee-cdb`, or `custom-oracle-se2-cdb`
+ `--engine-version cev`, where *cev* is the name of the custom engine version to be deleted
The following example deletes a CEV named `19.my_cev1`.
**Example**
For Linux, macOS, or Unix:
```
1. aws rds delete-custom-db-engine-version \
2. --engine custom-oracle-ee \
3. --engine-version 19.my_cev1
```
For Windows:
```
1. aws rds delete-custom-db-engine-version ^
2. --engine custom-oracle-ee ^
3. --engine-version 19.my_cev1
```