Package software.amazon.awscdk.services.rds

Class CfnDBParameterGroupProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • description

      @Stability(Stable) public CfnDBParameterGroupProps.Builder description(String description)
      Sets the value of CfnDBParameterGroupProps.getDescription()
      Parameters:
      description - Provides the customer-specified description for this DB parameter group. This parameter is required.
      Returns:
      this

    • family

      @Stability(Stable) public CfnDBParameterGroupProps.Builder family(String family)
      Sets the value of CfnDBParameterGroupProps.getFamily()
      Parameters:
      family - The DB parameter group family name. This parameter is required. 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
      Returns:
      this

    • dbParameterGroupName

      @Stability(Stable) public CfnDBParameterGroupProps.Builder dbParameterGroupName(String dbParameterGroupName)
      Sets the value of CfnDBParameterGroupProps.getDbParameterGroupName()
      Parameters:
      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.

      Returns:
      this

    • parameters

      @Stability(Stable) public CfnDBParameterGroupProps.Builder parameters(Object parameters)
      Sets the value of CfnDBParameterGroupProps.getParameters()
      Parameters:
      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.

      Returns:
      this

    • tags

      @Stability(Stable) public CfnDBParameterGroupProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnDBParameterGroupProps.getTags()
      Parameters:
      tags - Tags to assign to the DB parameter group.
      Returns:
      this

    • build

      @Stability(Stable) public CfnDBParameterGroupProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDBParameterGroupProps>
      Returns:
      a new instance of CfnDBParameterGroupProps
      Throws:
      NullPointerException - if any required attribute was not provided