interface CfnCustomDBEngineVersionProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.RDS.CfnCustomDBEngineVersionProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsrds#CfnCustomDBEngineVersionProps |
![]() | software.amazon.awscdk.services.rds.CfnCustomDBEngineVersionProps |
![]() | aws_cdk.aws_rds.CfnCustomDBEngineVersionProps |
![]() | aws-cdk-lib » aws_rds » CfnCustomDBEngineVersionProps |
Properties for defining a CfnCustomDBEngineVersion
.
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 cfnCustomDBEngineVersionProps: rds.CfnCustomDBEngineVersionProps = {
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,
};
Properties
Name | Type | Description |
---|---|---|
engine | string | The database engine to use for your custom engine version (CEV). |
engine | string | The name of your CEV. |
database | string | The name of an Amazon S3 bucket that contains database installation files for your CEV. |
database | string | The Amazon S3 directory that contains the database installation files for your CEV. |
description? | string | An optional description of your CEV. |
image | string | A value that indicates the ID of the AMI. |
kms | 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. |
source | 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? | Cfn [] | A list of tags. |
use | 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:
Cfn
[]
(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
.