Package software.amazon.awscdk.services.rds

Class CfnCustomDBEngineVersionProps.Builder

java.lang.Object

software.amazon.awscdk.services.rds.CfnCustomDBEngineVersionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCustomDBEngineVersionProps>

Enclosing interface:

CfnCustomDBEngineVersionProps

@Stability(Stable)
public static final class CfnCustomDBEngineVersionProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCustomDBEngineVersionProps>

A builder for CfnCustomDBEngineVersionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnCustomDBEngineVersionProps	build()	Builds the configured instance.
CfnCustomDBEngineVersionProps.Builder	databaseInstallationFilesS3BucketName(String databaseInstallationFilesS3BucketName)	Sets the value of CfnCustomDBEngineVersionProps.getDatabaseInstallationFilesS3BucketName()
CfnCustomDBEngineVersionProps.Builder	databaseInstallationFilesS3Prefix(String databaseInstallationFilesS3Prefix)	Sets the value of CfnCustomDBEngineVersionProps.getDatabaseInstallationFilesS3Prefix()
CfnCustomDBEngineVersionProps.Builder	description(String description)	Sets the value of CfnCustomDBEngineVersionProps.getDescription()
CfnCustomDBEngineVersionProps.Builder	engine(String engine)	Sets the value of CfnCustomDBEngineVersionProps.getEngine()
CfnCustomDBEngineVersionProps.Builder	engineVersion(String engineVersion)	Sets the value of CfnCustomDBEngineVersionProps.getEngineVersion()
CfnCustomDBEngineVersionProps.Builder	imageId(String imageId)	Sets the value of CfnCustomDBEngineVersionProps.getImageId()
CfnCustomDBEngineVersionProps.Builder	kmsKeyId(String kmsKeyId)	Sets the value of CfnCustomDBEngineVersionProps.getKmsKeyId()
CfnCustomDBEngineVersionProps.Builder	manifest(String manifest)	Sets the value of CfnCustomDBEngineVersionProps.getManifest()
CfnCustomDBEngineVersionProps.Builder	sourceCustomDbEngineVersionIdentifier(String sourceCustomDbEngineVersionIdentifier)	Sets the value of CfnCustomDBEngineVersionProps.getSourceCustomDbEngineVersionIdentifier()
CfnCustomDBEngineVersionProps.Builder	status(String status)	Sets the value of CfnCustomDBEngineVersionProps.getStatus()
CfnCustomDBEngineVersionProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnCustomDBEngineVersionProps.getTags()
CfnCustomDBEngineVersionProps.Builder	useAwsProvidedLatestImage(Boolean useAwsProvidedLatestImage)	Sets the value of CfnCustomDBEngineVersionProps.getUseAwsProvidedLatestImage()
CfnCustomDBEngineVersionProps.Builder	useAwsProvidedLatestImage(IResolvable useAwsProvidedLatestImage)	Sets the value of CfnCustomDBEngineVersionProps.getUseAwsProvidedLatestImage()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

engine

@Stability(Stable)
public CfnCustomDBEngineVersionProps.Builder engine(String engine)

Sets the value of CfnCustomDBEngineVersionProps.getEngine()

Parameters:

engine - The database engine to use for your custom engine version (CEV). This parameter is required. Valid values:

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

Returns:

this

engineVersion

@Stability(Stable)
public CfnCustomDBEngineVersionProps.Builder engineVersion(String engineVersion)

Sets the value of CfnCustomDBEngineVersionProps.getEngineVersion()

Parameters:

engineVersion - The name of your CEV. This parameter is required. 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$ }

Returns:

this

databaseInstallationFilesS3BucketName

@Stability(Stable)
public CfnCustomDBEngineVersionProps.Builder databaseInstallationFilesS3BucketName(String databaseInstallationFilesS3BucketName)

Sets the value of CfnCustomDBEngineVersionProps.getDatabaseInstallationFilesS3BucketName()

Parameters:

databaseInstallationFilesS3BucketName - 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 .

Returns:

this

databaseInstallationFilesS3Prefix

@Stability(Stable)
public CfnCustomDBEngineVersionProps.Builder databaseInstallationFilesS3Prefix(String databaseInstallationFilesS3Prefix)

Sets the value of CfnCustomDBEngineVersionProps.getDatabaseInstallationFilesS3Prefix()

Parameters:

databaseInstallationFilesS3Prefix - 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.

Returns:

this

description

@Stability(Stable)
public CfnCustomDBEngineVersionProps.Builder description(String description)

Sets the value of CfnCustomDBEngineVersionProps.getDescription()

Parameters:

description - An optional description of your CEV.

Returns:

this

imageId

@Stability(Stable)
public CfnCustomDBEngineVersionProps.Builder imageId(String imageId)

Sets the value of CfnCustomDBEngineVersionProps.getImageId()

Parameters:

imageId - A value that indicates the ID of the AMI.

Returns:

this

kmsKeyId

@Stability(Stable)
public CfnCustomDBEngineVersionProps.Builder kmsKeyId(String kmsKeyId)

Sets the value of CfnCustomDBEngineVersionProps.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

@Stability(Stable)
public CfnCustomDBEngineVersionProps.Builder manifest(String manifest)

Sets the value of CfnCustomDBEngineVersionProps.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 .

Returns:

this

sourceCustomDbEngineVersionIdentifier

@Stability(Stable)
public CfnCustomDBEngineVersionProps.Builder sourceCustomDbEngineVersionIdentifier(String sourceCustomDbEngineVersionIdentifier)

Sets the value of CfnCustomDBEngineVersionProps.getSourceCustomDbEngineVersionIdentifier()

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 either Source or UseAwsProvidedLatestImage . You can't specify a different JSON manifest when you specify SourceCustomDbEngineVersionIdentifier .

Returns:

this

status

@Stability(Stable)
public CfnCustomDBEngineVersionProps.Builder status(String status)

Sets the value of CfnCustomDBEngineVersionProps.getStatus()

Parameters:

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

Returns:

this

tags

@Stability(Stable)
public CfnCustomDBEngineVersionProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnCustomDBEngineVersionProps.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 CfnCustomDBEngineVersionProps.Builder useAwsProvidedLatestImage(Boolean useAwsProvidedLatestImage)

Sets the value of CfnCustomDBEngineVersionProps.getUseAwsProvidedLatestImage()

Parameters:

useAwsProvidedLatestImage - 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 .

Returns:

this

useAwsProvidedLatestImage

@Stability(Stable)
public CfnCustomDBEngineVersionProps.Builder useAwsProvidedLatestImage(IResolvable useAwsProvidedLatestImage)

Sets the value of CfnCustomDBEngineVersionProps.getUseAwsProvidedLatestImage()

Parameters:

useAwsProvidedLatestImage - 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 .

Returns:

this

build

@Stability(Stable)
public CfnCustomDBEngineVersionProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnCustomDBEngineVersionProps>

Returns:

a new instance of CfnCustomDBEngineVersionProps

Throws:

NullPointerException - if any required attribute was not provided