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 Details

    • Builder

      public Builder()

  • Method Details

    • description

      @Stability(Stable) public CfnDBClusterParameterGroupProps.Builder description(String description)
      Sets the value of CfnDBClusterParameterGroupProps.getDescription()
      Parameters:
      description - The description for the 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 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
      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.

      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 - Tags to assign to the 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