Package software.amazon.awscdk.services.rds

Class CfnDBParameterGroup.Builder

java.lang.Object

software.amazon.awscdk.services.rds.CfnDBParameterGroup.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDBParameterGroup>

Enclosing class:

CfnDBParameterGroup

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

A fluent builder for CfnDBParameterGroup.

Method Summary

Modifier and Type	Method	Description
CfnDBParameterGroup	build()
static CfnDBParameterGroup.Builder	create(software.constructs.Construct scope, String id)
CfnDBParameterGroup.Builder	dbParameterGroupName(String dbParameterGroupName)	The name of the DB parameter group.
CfnDBParameterGroup.Builder	description(String description)	Provides the customer-specified description for this DB parameter group.
CfnDBParameterGroup.Builder	family(String family)	The DB parameter group family name.
CfnDBParameterGroup.Builder	parameters(Object parameters)	An array of parameter names and values for the parameter update.
CfnDBParameterGroup.Builder	tags(List<? extends CfnTag> tags)	Tags to assign to the DB 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 CfnDBParameterGroup.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 CfnDBParameterGroup.Builder.

description

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

Provides the customer-specified description for this DB parameter group.

Parameters:

description - Provides the customer-specified description for this DB parameter group. This parameter is required.

Returns:

this

See Also:

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

family

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

The DB parameter group family name.

A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

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 MySQL DB engine, use the following command:

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

The output contains duplicates.

The following are the valid DB engine values:

• aurora-mysql
• aurora-postgresql
• db2-ae
• db2-se
• mysql
• oracle-ee
• oracle-ee-cdb
• oracle-se2
• oracle-se2-cdb
• postgres
• sqlserver-ee
• sqlserver-se
• sqlserver-ex
• sqlserver-web

Parameters:

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

Returns:

this

See Also:

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

dbParameterGroupName

@Stability(Stable)
public CfnDBParameterGroup.Builder dbParameterGroupName(String dbParameterGroupName)

The name of the DB parameter group.

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

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

This value is stored as a lowercase string.

Parameters:

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

Returns:

this

See Also:

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

parameters

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

An array of parameter names and values for the parameter update.

You must specify at least one parameter name and value.

For more information about parameter groups, see Working with parameter groups in the Amazon RDS User Guide , or Working with parameter groups in the Amazon Aurora User Guide .

AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.

Parameters:

parameters - An array of parameter names and values for the parameter update. This parameter is required.

Returns:

this

See Also:

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

tags

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

Tags to assign to the DB parameter group.

Parameters:

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

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnDBParameterGroup build()

Specified by:

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

Returns:

a newly built instance of CfnDBParameterGroup.