Package software.amazon.awscdk.services.rds

Class CfnCustomDBEngineVersion.Builder

java.lang.Object

software.amazon.awscdk.services.rds.CfnCustomDBEngineVersion.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCustomDBEngineVersion>

Enclosing class:

CfnCustomDBEngineVersion

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

A fluent builder for CfnCustomDBEngineVersion.

Method Summary

Modifier and Type	Method	Description
CfnCustomDBEngineVersion	build()
static CfnCustomDBEngineVersion.Builder	create(software.constructs.Construct scope, String id)
CfnCustomDBEngineVersion.Builder	databaseInstallationFilesS3BucketName(String databaseInstallationFilesS3BucketName)	The name of an Amazon S3 bucket that contains database installation files for your CEV.
CfnCustomDBEngineVersion.Builder	databaseInstallationFilesS3Prefix(String databaseInstallationFilesS3Prefix)	The Amazon S3 directory that contains the database installation files for your CEV.
CfnCustomDBEngineVersion.Builder	description(String description)	An optional description of your CEV.
CfnCustomDBEngineVersion.Builder	engine(String engine)	The database engine to use for your custom engine version (CEV).
CfnCustomDBEngineVersion.Builder	engineVersion(String engineVersion)	The name of your CEV.
CfnCustomDBEngineVersion.Builder	imageId(String imageId)	A value that indicates the ID of the AMI.
CfnCustomDBEngineVersion.Builder	kmsKeyId(String kmsKeyId)	The AWS KMS key identifier for an encrypted CEV.
CfnCustomDBEngineVersion.Builder	manifest(String manifest)	The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3.
CfnCustomDBEngineVersion.Builder	sourceCustomDbEngineVersionIdentifier(String sourceCustomDbEngineVersionIdentifier)	The ARN of a CEV to use as a source for creating a new CEV.
CfnCustomDBEngineVersion.Builder	status(String status)	A value that indicates the status of a custom engine version (CEV).
CfnCustomDBEngineVersion.Builder	tags(List<? extends CfnTag> tags)	A list of tags.
CfnCustomDBEngineVersion.Builder	useAwsProvidedLatestImage(Boolean useAwsProvidedLatestImage)	Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.
CfnCustomDBEngineVersion.Builder	useAwsProvidedLatestImage(IResolvable useAwsProvidedLatestImage)	Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnCustomDBEngineVersion.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnCustomDBEngineVersion.Builder.

engine

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

The database engine to use for your custom engine version (CEV).

Valid values:

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-engine

engineVersion

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

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$ }

Parameters:

engineVersion - The name of your CEV. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-engineversion

databaseInstallationFilesS3BucketName

@Stability(Stable)
public CfnCustomDBEngineVersion.Builder databaseInstallationFilesS3BucketName(String 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 .

Parameters:

databaseInstallationFilesS3BucketName - The name of an Amazon S3 bucket that contains database installation files for your CEV. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-databaseinstallationfiless3bucketname

databaseInstallationFilesS3Prefix

@Stability(Stable)
public CfnCustomDBEngineVersion.Builder databaseInstallationFilesS3Prefix(String 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.

Parameters:

databaseInstallationFilesS3Prefix - The Amazon S3 directory that contains the database installation files for your CEV. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-databaseinstallationfiless3prefix

description

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

An optional description of your CEV.

Parameters:

description - An optional description of your CEV. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-description

imageId

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

A value that indicates the ID of the AMI.

Parameters:

imageId - A value that indicates the ID of the AMI. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-imageid

kmsKeyId

@Stability(Stable)
public CfnCustomDBEngineVersion.Builder kmsKeyId(String 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.

Parameters:

kmsKeyId - The AWS KMS key identifier for an encrypted CEV. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-kmskeyid

manifest

@Stability(Stable)
public CfnCustomDBEngineVersion.Builder manifest(String 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 .

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-manifest

sourceCustomDbEngineVersionIdentifier

@Stability(Stable)
public CfnCustomDBEngineVersion.Builder sourceCustomDbEngineVersionIdentifier(String 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 .

Parameters:

sourceCustomDbEngineVersionIdentifier - The ARN of a CEV to use as a source for creating a new CEV. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-sourcecustomdbengineversionidentifier

status

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

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

Default: - "available"

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-status

tags

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

A list of tags.

For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Parameters:

tags - A list of tags. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-tags

useAwsProvidedLatestImage

@Stability(Stable)
public CfnCustomDBEngineVersion.Builder useAwsProvidedLatestImage(Boolean 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 .

Parameters:

useAwsProvidedLatestImage - Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-useawsprovidedlatestimage

useAwsProvidedLatestImage

@Stability(Stable)
public CfnCustomDBEngineVersion.Builder useAwsProvidedLatestImage(IResolvable 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 .

Parameters:

useAwsProvidedLatestImage - Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-useawsprovidedlatestimage

build

@Stability(Stable)
public CfnCustomDBEngineVersion build()

Specified by:

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

Returns:

a newly built instance of CfnCustomDBEngineVersion.