CfnCustomDBEngineVersionProps Struct
Properties for defining a CfnCustomDBEngineVersion.
| Source | |
|---|---|
| Type last changed |
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
databaseInstallationFiles: ['databaseInstallationFiles'],
databaseInstallationFilesS3BucketName: 'databaseInstallationFilesS3BucketName',
databaseInstallationFilesS3Prefix: 'databaseInstallationFilesS3Prefix',
description: 'description',
imageId: 'imageId',
kmsKeyId: 'kmsKeyId',
manifest: 'manifest',
sourceCustomDbEngineVersionIdentifier: 'sourceCustomDbEngineVersionIdentifier',
status: 'status',
tags: [{
key: 'key',
value: 'value',
}],
useAwsProvidedLatestImage: false,
};
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds
cfn_custom_db_engine_version_props = rds.CfnCustomDBEngineVersionProps(
engine="engine",
engine_version="engineVersion",
# the properties below are optional
database_installation_files=["databaseInstallationFiles"],
database_installation_files_s3_bucket_name="databaseInstallationFilesS3BucketName",
database_installation_files_s3_prefix="databaseInstallationFilesS3Prefix",
description="description",
image_id="imageId",
kms_key_id="kmsKeyId",
manifest="manifest",
source_custom_db_engine_version_identifier="sourceCustomDbEngineVersionIdentifier",
status="status",
tags=[CfnTag(
key="key",
value="value"
)],
use_aws_provided_latest_image=False
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.rds.*;
CfnCustomDBEngineVersionProps cfnCustomDBEngineVersionProps = CfnCustomDBEngineVersionProps.builder()
.engine("engine")
.engineVersion("engineVersion")
// the properties below are optional
.databaseInstallationFiles(List.of("databaseInstallationFiles"))
.databaseInstallationFilesS3BucketName("databaseInstallationFilesS3BucketName")
.databaseInstallationFilesS3Prefix("databaseInstallationFilesS3Prefix")
.description("description")
.imageId("imageId")
.kmsKeyId("kmsKeyId")
.manifest("manifest")
.sourceCustomDbEngineVersionIdentifier("sourceCustomDbEngineVersionIdentifier")
.status("status")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.useAwsProvidedLatestImage(false)
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RDS;
var cfnCustomDBEngineVersionProps = new CfnCustomDBEngineVersionProps {
Engine = "engine",
EngineVersion = "engineVersion",
// the properties below are optional
DatabaseInstallationFiles = new [] { "databaseInstallationFiles" },
DatabaseInstallationFilesS3BucketName = "databaseInstallationFilesS3BucketName",
DatabaseInstallationFilesS3Prefix = "databaseInstallationFilesS3Prefix",
Description = "description",
ImageId = "imageId",
KmsKeyId = "kmsKeyId",
Manifest = "manifest",
SourceCustomDbEngineVersionIdentifier = "sourceCustomDbEngineVersionIdentifier",
Status = "status",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
UseAwsProvidedLatestImage = false
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnCustomDBEngineVersionProps := &CfnCustomDBEngineVersionProps{
Engine: jsii.String("engine"),
EngineVersion: jsii.String("engineVersion"),
// the properties below are optional
DatabaseInstallationFiles: []*string{
jsii.String("databaseInstallationFiles"),
},
DatabaseInstallationFilesS3BucketName: jsii.String("databaseInstallationFilesS3BucketName"),
DatabaseInstallationFilesS3Prefix: jsii.String("databaseInstallationFilesS3Prefix"),
Description: jsii.String("description"),
ImageId: jsii.String("imageId"),
KmsKeyId: jsii.String("kmsKeyId"),
Manifest: jsii.String("manifest"),
SourceCustomDbEngineVersionIdentifier: jsii.String("sourceCustomDbEngineVersionIdentifier"),
Status: jsii.String("status"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
UseAwsProvidedLatestImage: jsii.Boolean(false),
}
Properties
databaseInstallationFilesoptionalstring[]database_installation_filesoptionaltyping.List[str]databaseInstallationFilesoptionalList<String>DatabaseInstallationFilesoptionalstring[]DatabaseInstallationFilesoptional*[]*string #databaseInstallationFilesS3BucketNameoptionalstringdatabase_installation_files_s3_bucket_nameoptionalstrdatabaseInstallationFilesS3BucketNameoptionalStringDatabaseInstallationFilesS3BucketNameoptionalstringDatabaseInstallationFilesS3BucketNameoptional*string #For example, a valid bucket name is my-custom-installation-files .
databaseInstallationFilesS3Prefixoptionalstringdatabase_installation_files_s3_prefixoptionalstrdatabaseInstallationFilesS3PrefixoptionalStringDatabaseInstallationFilesS3PrefixoptionalstringDatabaseInstallationFilesS3Prefixoptional*string #For example, a valid bucket name is 123456789012/cev1 . If this setting isn't specified, no prefix is assumed.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #Valid values:
custom-oracle-eecustom-oracle-ee-cdb
engineVersionstringengine_versionstrengineVersionStringEngineVersionstringEngineVersion*string required #notes
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$ }
imageIdoptionalstringimage_idoptionalstrimageIdoptionalStringImageIdoptionalstringImageIdoptional*string #kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*string #notes
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.
manifestoptionalstringmanifestoptionalstrmanifestoptionalStringManifestoptionalstringManifestoptional*string #notes
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 .
sourceCustomDbEngineVersionIdentifieroptionalstringsource_custom_db_engine_version_identifieroptionalstrsourceCustomDbEngineVersionIdentifieroptionalStringSourceCustomDbEngineVersionIdentifieroptionalstringSourceCustomDbEngineVersionIdentifieroptional*string #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 .
statusoptionalstringstatusoptionalstrstatusoptionalStringStatusoptionalstringStatusoptional*string = "available" #tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
useAwsProvidedLatestImageoptionalboolean | IResolvableuse_aws_provided_latest_imageoptionaltyping.Union[bool, IResolvable]useAwsProvidedLatestImageoptionalBooleanUseAwsProvidedLatestImageoptionalboolUseAwsProvidedLatestImageoptionalinterface{} #If you specify UseAwsProvidedLatestImage , you can't also specify ImageId .