Package software.amazon.awscdk.cfnpropertymixins.services.rds

Interface CfnCustomDBEngineVersionMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCustomDBEngineVersionMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:04.268Z")
@Stability(Stable)
public interface CfnCustomDBEngineVersionMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnCustomDBEngineVersionPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.rds.*;
 CfnCustomDBEngineVersionMixinProps cfnCustomDBEngineVersionMixinProps = CfnCustomDBEngineVersionMixinProps.builder()
         .databaseInstallationFilesS3BucketName("databaseInstallationFilesS3BucketName")
         .databaseInstallationFilesS3Prefix("databaseInstallationFilesS3Prefix")
         .description("description")
         .engine("engine")
         .engineVersion("engineVersion")
         .imageId("imageId")
         .kmsKeyId("kmsKeyId")
         .manifest("manifest")
         .sourceCustomDbEngineVersionIdentifier("sourceCustomDbEngineVersionIdentifier")
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .useAwsProvidedLatestImage(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCustomDBEngineVersionMixinProps.Builder	A builder for CfnCustomDBEngineVersionMixinProps
static final class	CfnCustomDBEngineVersionMixinProps.Jsii$Proxy	An implementation for CfnCustomDBEngineVersionMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnCustomDBEngineVersionMixinProps.Builder	builder()
default String	getDatabaseInstallationFilesS3BucketName()	The name of an Amazon S3 bucket that contains database installation files for your CEV.
default String	getDatabaseInstallationFilesS3Prefix()	The Amazon S3 directory that contains the database installation files for your CEV.
default String	getDescription()	An optional description of your CEV.
default String	getEngine()	The database engine to use for your custom engine version (CEV).
default String	getEngineVersion()	The name of your CEV.
default String	getImageId()	A value that indicates the ID of the AMI.
default String	getKmsKeyId()	The AWS KMS key identifier for an encrypted CEV.
default String	getManifest()	The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3.
default String	getSourceCustomDbEngineVersionIdentifier()	The ARN of a CEV to use as a source for creating a new CEV.
default String	getStatus()	A value that indicates the status of a custom engine version (CEV).
default List<CfnTag>	getTags()	A list of tags.
default Object	getUseAwsProvidedLatestImage()	Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatabaseInstallationFilesS3BucketName

@Stability(Stable)
@Nullable
default String getDatabaseInstallationFilesS3BucketName()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-databaseinstallationfiless3bucketname

getDatabaseInstallationFilesS3Prefix

@Stability(Stable)
@Nullable
default String getDatabaseInstallationFilesS3Prefix()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-databaseinstallationfiless3prefix

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

An optional description of your CEV.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-description

getEngine

@Stability(Stable)
@Nullable
default String getEngine()

The database engine to use for your custom engine version (CEV).

Valid values:

• custom-oracle-ee
• custom-oracle-ee-cdb

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-engine

getEngineVersion

@Stability(Stable)
@Nullable
default String getEngineVersion()

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$ }

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-engineversion

getImageId

@Stability(Stable)
@Nullable
default String getImageId()

A value that indicates the ID of the AMI.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-imageid

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-kmskeyid

getManifest

@Stability(Stable)
@Nullable
default String getManifest()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-manifest

getSourceCustomDbEngineVersionIdentifier

@Stability(Stable)
@Nullable
default String getSourceCustomDbEngineVersionIdentifier()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-sourcecustomdbengineversionidentifier

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

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

Default: - "available"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-status

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of tags.

For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-tags

getUseAwsProvidedLatestImage

@Stability(Stable)
@Nullable
default Object getUseAwsProvidedLatestImage()

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 .

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-useawsprovidedlatestimage

builder

@Stability(Stable)
static CfnCustomDBEngineVersionMixinProps.Builder builder()

Returns:

a CfnCustomDBEngineVersionMixinProps.Builder of CfnCustomDBEngineVersionMixinProps