Package software.amazon.awscdk.services.rds

Class CfnOptionGroup.Builder

java.lang.Object

software.amazon.awscdk.services.rds.CfnOptionGroup.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnOptionGroup>

Enclosing class:

CfnOptionGroup

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

A fluent builder for CfnOptionGroup.

Method Summary

Modifier and Type	Method	Description
CfnOptionGroup	build()
static CfnOptionGroup.Builder	create(software.constructs.Construct scope, String id)
CfnOptionGroup.Builder	engineName(String engineName)	Specifies the name of the engine that this option group should be associated with.
CfnOptionGroup.Builder	majorEngineVersion(String majorEngineVersion)	Specifies the major version of the engine that this option group should be associated with.
CfnOptionGroup.Builder	optionConfigurations(List<? extends Object> optionConfigurations)	A list of options and the settings for each option.
CfnOptionGroup.Builder	optionConfigurations(IResolvable optionConfigurations)	A list of options and the settings for each option.
CfnOptionGroup.Builder	optionGroupDescription(String optionGroupDescription)	The description of the option group.
CfnOptionGroup.Builder	optionGroupName(String optionGroupName)	The name of the option group to be created.
CfnOptionGroup.Builder	tags(List<? extends CfnTag> tags)	An optional array of key-value pairs to apply to this option group.

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 CfnOptionGroup.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 CfnOptionGroup.Builder.

engineName

@Stability(Stable)
public CfnOptionGroup.Builder engineName(String engineName)

Specifies the name of the engine that this option group should be associated with.

Valid Values:

• mariadb
• mysql
• oracle-ee
• oracle-ee-cdb
• oracle-se2
• oracle-se2-cdb
• postgres
• sqlserver-ee
• sqlserver-se
• sqlserver-ex
• sqlserver-web

Parameters:

engineName - Specifies the name of the engine that this option group should be associated with. This parameter is required.

Returns:

this

See Also:

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

majorEngineVersion

@Stability(Stable)
public CfnOptionGroup.Builder majorEngineVersion(String majorEngineVersion)

Specifies the major version of the engine that this option group should be associated with.

Parameters:

majorEngineVersion - Specifies the major version of the engine that this option group should be associated with. This parameter is required.

Returns:

this

See Also:

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

optionGroupDescription

@Stability(Stable)
public CfnOptionGroup.Builder optionGroupDescription(String optionGroupDescription)

The description of the option group.

Parameters:

optionGroupDescription - The description of the option group. This parameter is required.

Returns:

this

See Also:

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

optionConfigurations

@Stability(Stable)
public CfnOptionGroup.Builder optionConfigurations(IResolvable optionConfigurations)

A list of options and the settings for each option.

Parameters:

optionConfigurations - A list of options and the settings for each option. This parameter is required.

Returns:

this

See Also:

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

optionConfigurations

@Stability(Stable)
public CfnOptionGroup.Builder optionConfigurations(List<? extends Object> optionConfigurations)

A list of options and the settings for each option.

Parameters:

optionConfigurations - A list of options and the settings for each option. This parameter is required.

Returns:

this

See Also:

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

optionGroupName

@Stability(Stable)
public CfnOptionGroup.Builder optionGroupName(String optionGroupName)

The name of the option group to be created.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens
• First character must be a letter
• Can't end with a hyphen or contain two consecutive hyphens

Example: myoptiongroup

If you don't specify a value for OptionGroupName property, a name is automatically created for the option group.

This value is stored as a lowercase string.

Parameters:

optionGroupName - The name of the option group to be created. This parameter is required.

Returns:

this

See Also:

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

tags

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

An optional array of key-value pairs to apply to this option group.

Parameters:

tags - An optional array of key-value pairs to apply to this option group. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnOptionGroup build()

Specified by:

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

Returns:

a newly built instance of CfnOptionGroup.