software.amazon.awscdk.services.rds

Class CfnDBClusterParameterGroup.Builder

java.lang.Object

software.amazon.awscdk.services.rds.CfnDBClusterParameterGroup.Builder

Enclosing class:

CfnDBClusterParameterGroup

public static final class CfnDBClusterParameterGroup.Builder
extends java.lang.Object

A fluent builder for CfnDBClusterParameterGroup.

Method Summary

Modifier and Type	Method and Description
CfnDBClusterParameterGroup	build()
static CfnDBClusterParameterGroup.Builder	create(Construct scope, java.lang.String id)
CfnDBClusterParameterGroup.Builder	dbClusterParameterGroupName(java.lang.String dbClusterParameterGroupName) The name of the DB cluster parameter group.
CfnDBClusterParameterGroup.Builder	description(java.lang.String description) A friendly description for this DB cluster parameter group.
CfnDBClusterParameterGroup.Builder	family(java.lang.String family) The DB cluster parameter group family name.
CfnDBClusterParameterGroup.Builder	parameters(java.lang.Object parameters) Provides a list of parameters for the DB cluster parameter group.
CfnDBClusterParameterGroup.Builder	tags(java.util.List<? extends CfnTag> tags) An optional array of key-value pairs to apply to this DB cluster parameter group.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static CfnDBClusterParameterGroup.Builder create(Construct scope,
                                                        java.lang.String id)

Parameters:

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

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnDBClusterParameterGroup.Builder.

description

public CfnDBClusterParameterGroup.Builder description(java.lang.String description)

A friendly description for this DB cluster parameter group.

Parameters:

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

Returns:

this

family

public CfnDBClusterParameterGroup.Builder family(java.lang.String family)

The DB cluster parameter group family name.

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

Parameters:

family - The DB cluster parameter group family name. This parameter is required.

Returns:

this

parameters

public CfnDBClusterParameterGroup.Builder parameters(java.lang.Object parameters)

Provides a list of parameters for the DB cluster parameter group.

Parameters:

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

Returns:

this

dbClusterParameterGroupName

public CfnDBClusterParameterGroup.Builder dbClusterParameterGroupName(java.lang.String 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 paramter group.

This value is stored as a lowercase string.

Parameters:

dbClusterParameterGroupName - The name of the DB cluster parameter group. This parameter is required.

Returns:

this

tags

public CfnDBClusterParameterGroup.Builder tags(java.util.List<? extends CfnTag> tags)

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

Parameters:

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

Returns:

this

build

public CfnDBClusterParameterGroup build()