Package software.amazon.awscdk.cfnpropertymixins.services.rds

Class CfnDBClusterParameterGroupPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.rds.CfnDBClusterParameterGroupPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDBClusterParameterGroupPropsMixin>

Enclosing class:

CfnDBClusterParameterGroupPropsMixin

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

A fluent builder for CfnDBClusterParameterGroupPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnDBClusterParameterGroupPropsMixin	build()
static CfnDBClusterParameterGroupPropsMixin.Builder	create()
static CfnDBClusterParameterGroupPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnDBClusterParameterGroupPropsMixin.Builder	dbClusterParameterGroupName(String dbClusterParameterGroupName)	The name of the DB cluster parameter group.
CfnDBClusterParameterGroupPropsMixin.Builder	description(String description)	The description for the DB cluster parameter group.
CfnDBClusterParameterGroupPropsMixin.Builder	family(String family)	The DB cluster parameter group family name.
CfnDBClusterParameterGroupPropsMixin.Builder	parameters(Object parameters)	Provides a list of parameters for the DB cluster parameter group.
CfnDBClusterParameterGroupPropsMixin.Builder	tags(List<? extends CfnTag> tags)	Tags to assign to the DB cluster parameter 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 CfnDBClusterParameterGroupPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnDBClusterParameterGroupPropsMixin.Builder.

create

@Stability(Stable)
public static CfnDBClusterParameterGroupPropsMixin.Builder create()

Returns:

a new instance of CfnDBClusterParameterGroupPropsMixin.Builder.

dbClusterParameterGroupName

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

The name of the DB cluster parameter group.

Constraints:

• Must not match the name of an existing DB cluster parameter 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

See Also:

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

description

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

The description for the DB cluster parameter group.

Parameters:

description - The description for the DB cluster parameter group. This parameter is required.

Returns:

this

See Also:

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

family

@Stability(Stable)
public CfnDBClusterParameterGroupPropsMixin.Builder family(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 database engine and engine version compatible with that DB cluster parameter group family.

Aurora MySQL

Example: aurora-mysql5.7 , aurora-mysql8.0

Aurora PostgreSQL

Example: aurora-postgresql14

RDS for MySQL

Example: mysql8.0

RDS for PostgreSQL

Example: postgres13

To list all of the available parameter group families for a DB engine, use the following command:

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

For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:

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

The output contains duplicates.

The following are the valid DB engine values:

• aurora-mysql
• aurora-postgresql
• mysql
• postgres

Parameters:

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

Returns:

this

See Also:

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

parameters

@Stability(Stable)
public CfnDBClusterParameterGroupPropsMixin.Builder parameters(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

See Also:

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

tags

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

Tags to assign to the DB cluster parameter group.

Parameters:

tags - Tags to assign to the DB cluster parameter group. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnDBClusterParameterGroupPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnDBClusterParameterGroupPropsMixin.