Package software.amazon.awscdk.services.rds

Class CfnDBClusterParameterGroupProps.Builder

java.lang.Object

software.amazon.awscdk.services.rds.CfnDBClusterParameterGroupProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDBClusterParameterGroupProps>

Enclosing interface:

CfnDBClusterParameterGroupProps

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

A builder for CfnDBClusterParameterGroupProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDBClusterParameterGroupProps	build()	Builds the configured instance.
CfnDBClusterParameterGroupProps.Builder	dbClusterParameterGroupName(String dbClusterParameterGroupName)	Sets the value of CfnDBClusterParameterGroupProps.getDbClusterParameterGroupName()
CfnDBClusterParameterGroupProps.Builder	description(String description)	Sets the value of CfnDBClusterParameterGroupProps.getDescription()
CfnDBClusterParameterGroupProps.Builder	family(String family)	Sets the value of CfnDBClusterParameterGroupProps.getFamily()
CfnDBClusterParameterGroupProps.Builder	parameters(Object parameters)	Sets the value of CfnDBClusterParameterGroupProps.getParameters()
CfnDBClusterParameterGroupProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnDBClusterParameterGroupProps.getTags()

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

description

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

Sets the value of CfnDBClusterParameterGroupProps.getDescription()

Parameters:

description - A friendly description for this DB cluster parameter group. This parameter is required.

Returns:

this

family

@Stability(Stable)
public CfnDBClusterParameterGroupProps.Builder family(String family)

Sets the value of CfnDBClusterParameterGroupProps.getFamily()

Parameters:

family - The DB cluster parameter group family name. This parameter is required. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family.

The DB cluster parameter group family can't be changed when updating a DB cluster parameter group.

To list all of the available parameter group families, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"

The output contains duplicates.

For more information, see [CreateDBClusterParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBClusterParameterGroup.html) .

Returns:

this

parameters

@Stability(Stable)
public CfnDBClusterParameterGroupProps.Builder parameters(Object parameters)

Sets the value of CfnDBClusterParameterGroupProps.getParameters()

Parameters:

parameters - Provides a list of parameters for the DB cluster parameter group. This parameter is required.

Returns:

this

dbClusterParameterGroupName

@Stability(Stable)
public CfnDBClusterParameterGroupProps.Builder dbClusterParameterGroupName(String dbClusterParameterGroupName)

Sets the value of CfnDBClusterParameterGroupProps.getDbClusterParameterGroupName()

Parameters:

dbClusterParameterGroupName - The name of the DB cluster parameter group. Constraints:

• Must not match the name of an existing DB cluster parameter group.

If you don't specify a value for DBClusterParameterGroupName property, a name is automatically created for the DB cluster parameter group.

This value is stored as a lowercase string.

Returns:

this

tags

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

Sets the value of CfnDBClusterParameterGroupProps.getTags()

Parameters:

tags - An optional array of key-value pairs to apply to this DB cluster parameter group.

Returns:

this

build

@Stability(Stable)
public CfnDBClusterParameterGroupProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDBClusterParameterGroupProps

Throws:

NullPointerException - if any required attribute was not provided