class CfnCustomDBEngineVersion (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.RDS.CfnCustomDBEngineVersion`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsrds#CfnCustomDBEngineVersion`
Java	`software.amazon.awscdk.services.rds.CfnCustomDBEngineVersion`
Python	`aws_cdk.aws_rds.CfnCustomDBEngineVersion`
TypeScript	`aws-cdk-lib` » `aws_rds` » `CfnCustomDBEngineVersion`

Implements IConstruct, IDependable, IInspectable, ITaggableV2

Creates a custom DB engine version (CEV).

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_rds as rds } from 'aws-cdk-lib';
const cfnCustomDBEngineVersion = new rds.CfnCustomDBEngineVersion(this, 'MyCfnCustomDBEngineVersion', {
  engine: 'engine',
  engineVersion: 'engineVersion',

  // the properties below are optional
  databaseInstallationFilesS3BucketName: 'databaseInstallationFilesS3BucketName',
  databaseInstallationFilesS3Prefix: 'databaseInstallationFilesS3Prefix',
  description: 'description',
  imageId: 'imageId',
  kmsKeyId: 'kmsKeyId',
  manifest: 'manifest',
  sourceCustomDbEngineVersionIdentifier: 'sourceCustomDbEngineVersionIdentifier',
  status: 'status',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  useAwsProvidedLatestImage: false,
});

Initializer

new CfnCustomDBEngineVersion(scope: Construct, id: string, props: CfnCustomDBEngineVersionProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnCustomDBEngineVersionProps — Resource properties.

Construct Props

Name	Type	Description
engine	`string`	The database engine to use for your custom engine version (CEV).
engineVersion	`string`	The name of your CEV.
databaseInstallationFilesS3BucketName?	`string`	The name of an Amazon S3 bucket that contains database installation files for your CEV.
databaseInstallationFilesS3Prefix?	`string`	The Amazon S3 directory that contains the database installation files for your CEV.
description?	`string`	An optional description of your CEV.
imageId?	`string`	A value that indicates the ID of the AMI.
kmsKeyId?	`string`	The AWS KMS key identifier for an encrypted CEV.
manifest?	`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.
sourceCustomDbEngineVersionIdentifier?	`string`	The ARN of a CEV to use as a source for creating a new CEV.
status?	`string`	A value that indicates the status of a custom engine version (CEV).
tags?	`CfnTag[]`	A list of tags.
useAwsProvidedLatestImage?	`boolean \|` `IResolvable`	Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.

engine

Type: string

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

Valid values:

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

engineVersion

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

databaseInstallationFilesS3BucketName?

Type: string (optional)

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 .

databaseInstallationFilesS3Prefix?

Type: string (optional)

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.

description?

Type: string (optional)

An optional description of your CEV.

imageId?

Type: string (optional)

A value that indicates the ID of the AMI.

kmsKeyId?

Type: string (optional)

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.

manifest?

Type: string (optional)

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 .

sourceCustomDbEngineVersionIdentifier?

Type: string (optional)

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 .

status?

Type: string (optional, default: "available")

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

tags?

Type: CfnTag[] (optional)

A list of tags.

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

useAwsProvidedLatestImage?

Type: boolean | IResolvable (optional)

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 .

Properties

Name	Type	Description
attrDbEngineVersionArn	`string`	The ARN of the custom engine version.
cdkTagManager	`TagManager`	Tag Manager which manages the tags for this resource.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
engine	`string`	The database engine to use for your custom engine version (CEV).
engineVersion	`string`	The name of your CEV.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
databaseInstallationFilesS3BucketName?	`string`	The name of an Amazon S3 bucket that contains database installation files for your CEV.
databaseInstallationFilesS3Prefix?	`string`	The Amazon S3 directory that contains the database installation files for your CEV.
description?	`string`	An optional description of your CEV.
imageId?	`string`	A value that indicates the ID of the AMI.
kmsKeyId?	`string`	The AWS KMS key identifier for an encrypted CEV.
manifest?	`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.
sourceCustomDbEngineVersionIdentifier?	`string`	The ARN of a CEV to use as a source for creating a new CEV.
status?	`string`	A value that indicates the status of a custom engine version (CEV).
tags?	`CfnTag[]`	A list of tags.
useAwsProvidedLatestImage?	`boolean \|` `IResolvable`	Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrDbEngineVersionArn

Type: string

The ARN of the custom engine version.

cdkTagManager

Type: TagManager

Tag Manager which manages the tags for this resource.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

engine

Type: string

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

engineVersion

Type: string

The name of your CEV.

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

databaseInstallationFilesS3BucketName?

Type: string (optional)

The name of an Amazon S3 bucket that contains database installation files for your CEV.

databaseInstallationFilesS3Prefix?

Type: string (optional)

The Amazon S3 directory that contains the database installation files for your CEV.

description?

Type: string (optional)

An optional description of your CEV.

imageId?

Type: string (optional)

A value that indicates the ID of the AMI.

kmsKeyId?

Type: string (optional)

The AWS KMS key identifier for an encrypted CEV.

manifest?

Type: string (optional)

sourceCustomDbEngineVersionIdentifier?

Type: string (optional)

The ARN of a CEV to use as a source for creating a new CEV.

status?

Type: string (optional)

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

tags?

Type: CfnTag[] (optional)

A list of tags.

useAwsProvidedLatestImage?

Type: boolean | IResolvable (optional)

Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }