Class CfnCustomDBEngineVersionMixinProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnCustomDBEngineVersionMixinProps>
- Enclosing interface:
CfnCustomDBEngineVersionMixinProps
CfnCustomDBEngineVersionMixinProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.databaseInstallationFilesS3BucketName(String databaseInstallationFilesS3BucketName) databaseInstallationFilesS3Prefix(String databaseInstallationFilesS3Prefix) description(String description) Sets the value ofCfnCustomDBEngineVersionMixinProps.getDescription()Sets the value ofCfnCustomDBEngineVersionMixinProps.getEngine()engineVersion(String engineVersion) Sets the value ofCfnCustomDBEngineVersionMixinProps.getEngineVersion()Sets the value ofCfnCustomDBEngineVersionMixinProps.getImageId()Sets the value ofCfnCustomDBEngineVersionMixinProps.getKmsKeyId()Sets the value ofCfnCustomDBEngineVersionMixinProps.getManifest()sourceCustomDbEngineVersionIdentifier(String sourceCustomDbEngineVersionIdentifier) Sets the value ofCfnCustomDBEngineVersionMixinProps.getStatus()Sets the value ofCfnCustomDBEngineVersionMixinProps.getTags()useAwsProvidedLatestImage(Boolean useAwsProvidedLatestImage) Sets the value ofCfnCustomDBEngineVersionMixinProps.getUseAwsProvidedLatestImage()useAwsProvidedLatestImage(IResolvable useAwsProvidedLatestImage) Sets the value ofCfnCustomDBEngineVersionMixinProps.getUseAwsProvidedLatestImage()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
databaseInstallationFilesS3BucketName
@Stability(Stable) public CfnCustomDBEngineVersionMixinProps.Builder databaseInstallationFilesS3BucketName(String databaseInstallationFilesS3BucketName) - Parameters:
databaseInstallationFilesS3BucketName- The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name ismy-custom-installation-files.- Returns:
this
-
databaseInstallationFilesS3Prefix
@Stability(Stable) public CfnCustomDBEngineVersionMixinProps.Builder databaseInstallationFilesS3Prefix(String databaseInstallationFilesS3Prefix) - Parameters:
databaseInstallationFilesS3Prefix- The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is123456789012/cev1. If this setting isn't specified, no prefix is assumed.- Returns:
this
-
description
@Stability(Stable) public CfnCustomDBEngineVersionMixinProps.Builder description(String description) Sets the value ofCfnCustomDBEngineVersionMixinProps.getDescription()- Parameters:
description- An optional description of your CEV.- Returns:
this
-
engine
Sets the value ofCfnCustomDBEngineVersionMixinProps.getEngine()- Parameters:
engine- The database engine to use for your custom engine version (CEV). Valid values:custom-oracle-eecustom-oracle-ee-cdb
- Returns:
this
-
engineVersion
@Stability(Stable) public CfnCustomDBEngineVersionMixinProps.Builder engineVersion(String engineVersion) Sets the value ofCfnCustomDBEngineVersionMixinProps.getEngineVersion()- Parameters:
engineVersion- The name of your CEV. The name format ismajor 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$}- Returns:
this
-
imageId
Sets the value ofCfnCustomDBEngineVersionMixinProps.getImageId()- Parameters:
imageId- A value that indicates the ID of the AMI.- Returns:
this
-
kmsKeyId
Sets the value ofCfnCustomDBEngineVersionMixinProps.getKmsKeyId()- Parameters:
kmsKeyId- 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.
- Returns:
this
-
manifest
Sets the value ofCfnCustomDBEngineVersionMixinProps.getManifest()- Parameters:
manifest- 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 .
- MediaImportTemplateVersion - Version of the CEV manifest. The date is in the format
- Returns:
this
-
sourceCustomDbEngineVersionIdentifier
@Stability(Stable) public CfnCustomDBEngineVersionMixinProps.Builder sourceCustomDbEngineVersionIdentifier(String sourceCustomDbEngineVersionIdentifier) - Parameters:
sourceCustomDbEngineVersionIdentifier- 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 eitherSourceorUseAwsProvidedLatestImage. You can't specify a different JSON manifest when you specifySourceCustomDbEngineVersionIdentifier.- Returns:
this
-
status
Sets the value ofCfnCustomDBEngineVersionMixinProps.getStatus()- Parameters:
status- A value that indicates the status of a custom engine version (CEV).- Returns:
this
-
tags
@Stability(Stable) public CfnCustomDBEngineVersionMixinProps.Builder tags(List<? extends CfnTag> tags) Sets the value ofCfnCustomDBEngineVersionMixinProps.getTags()- Parameters:
tags- A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.- Returns:
this
-
useAwsProvidedLatestImage
@Stability(Stable) public CfnCustomDBEngineVersionMixinProps.Builder useAwsProvidedLatestImage(Boolean useAwsProvidedLatestImage) Sets the value ofCfnCustomDBEngineVersionMixinProps.getUseAwsProvidedLatestImage()- Parameters:
useAwsProvidedLatestImage- Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specifyUseAwsProvidedLatestImage, you can't also specifyImageId.- Returns:
this
-
useAwsProvidedLatestImage
@Stability(Stable) public CfnCustomDBEngineVersionMixinProps.Builder useAwsProvidedLatestImage(IResolvable useAwsProvidedLatestImage) Sets the value ofCfnCustomDBEngineVersionMixinProps.getUseAwsProvidedLatestImage()- Parameters:
useAwsProvidedLatestImage- Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specifyUseAwsProvidedLatestImage, you can't also specifyImageId.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnCustomDBEngineVersionMixinProps>- Returns:
- a new instance of
CfnCustomDBEngineVersionMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-