Package software.amazon.awscdk.services.rds

Class CfnDBClusterParameterGroup.Builder

java.lang.Object
software.amazon.awscdk.services.rds.CfnDBClusterParameterGroup.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDBClusterParameterGroup>
Enclosing class:
CfnDBClusterParameterGroup
@Stability(Stable) public static final class CfnDBClusterParameterGroup.Builder extends Object implements software.amazon.jsii.Builder<CfnDBClusterParameterGroup>
A fluent builder for CfnDBClusterParameterGroup.

  • Method Details

    • create

      @Stability(Stable) public static CfnDBClusterParameterGroup.Builder create(Construct scope, 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

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

      @Stability(Stable) public CfnDBClusterParameterGroup.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 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

      @Stability(Stable) public CfnDBClusterParameterGroup.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

    • dbClusterParameterGroupName

      @Stability(Stable) public CfnDBClusterParameterGroup.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.

      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.

      Parameters:
      dbClusterParameterGroupName - The name of the DB cluster parameter group. This parameter is required.
      Returns:
      this

    • tags

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

      @Stability(Stable) public CfnDBClusterParameterGroup build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDBClusterParameterGroup>
      Returns:
      a newly built instance of CfnDBClusterParameterGroup.