Interface CfnCustomDBEngineVersionProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnCustomDBEngineVersionProps.Jsii$Proxy
CfnCustomDBEngineVersion.
Example:
// 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
.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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnCustomDBEngineVersionPropsstatic final classAn implementation forCfnCustomDBEngineVersionProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringThe name of an Amazon S3 bucket that contains database installation files for your CEV.default StringThe Amazon S3 directory that contains the database installation files for your CEV.default StringAn optional description of your CEV.The database engine to use for your custom engine version (CEV).The name of your CEV.default StringA value that indicates the ID of the AMI.default StringThe AWS KMS key identifier for an encrypted CEV.default StringThe CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3.default StringThe ARN of a CEV to use as a source for creating a new CEV.default StringA value that indicates the status of a custom engine version (CEV).getTags()A list of tags.default ObjectSpecifies 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
-
getEngine
The database engine to use for your custom engine version (CEV).Valid values:
custom-oracle-eecustom-oracle-ee-cdb
- See Also:
-
getEngineVersion
The name of your CEV.The name format is
major version.customized_string. For example, a valid CEV name is19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination ofEngineandEngineVersionis unique per customer per Region.Constraints: Minimum length is 1. Maximum length is 60.
Pattern:
^[a-z0-9_.-]{1,60$}- See Also:
-
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:
-
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:
-
getDescription
An optional description of your CEV.- See Also:
-
getImageId
A value that indicates the ID of the AMI.- See Also:
-
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:
-
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:
- MediaImportTemplateVersion - Version of the CEV manifest. The date is in the format
-
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
SourceorUseAwsProvidedLatestImage. You can't specify a different JSON manifest when you specifySourceCustomDbEngineVersionIdentifier.- See Also:
-
getStatus
A value that indicates the status of a custom engine version (CEV).Default: - "available"
- See Also:
-
getTags
A list of tags.For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
- See Also:
-
getUseAwsProvidedLatestImage
Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.If you specify
UseAwsProvidedLatestImage, you can't also specifyImageId.- See Also:
-
builder
-