AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::RDS::CustomDBEngineVersion

CfnCustomDBEngineVersion

Creates a custom DB engine version (CEV).

Import

import { CfnCustomDBEngineVersion } from 'aws-cdk-lib/aws-rds';

Or use the module namespace:

import * as rds from 'aws-cdk-lib/aws-rds';
// rds.CfnCustomDBEngineVersion

Properties

Configuration passed to the constructor as CfnCustomDBEngineVersionProps.

engineRequired
string

The database engine to use for your custom engine version (CEV). Valid values: - `custom-oracle-ee` - `custom-oracle-ee-cdb`

engineVersionRequired
string

The name of your CEV. The name format is `major version.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. *Constraints:* Minimum length is 1. Maximum length is 60. *Pattern:* `^[a-z0-9_.-]{1,60$` }

databaseInstallationFilesS3BucketNameOptional
string

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` .

databaseInstallationFilesS3PrefixOptional
string

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.

descriptionOptional
string

An optional description of your CEV.

imageIdOptional
string

A value that indicates the ID of the AMI.

kmsKeyIdOptional
string

The AWS 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](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *AWS 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.

manifestOptional
string

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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide* .

sourceCustomDbEngineVersionIdentifierOptional
string

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` .

statusOptional
string

A value that indicates the status of a custom engine version (CEV).

Default: - "available"

tagsOptional
CfnTag[]

A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*

useAwsProvidedLatestImageOptional
boolean | IResolvable

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` .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Get the Amazon RDS Cheat Sheet

Everything you need to know about Amazon RDS on one page. HD quality, print-friendly.

Download Free Infographic