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>
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • description

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

      The DB parameter group family can't be changed when updating a DB 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 [CreateDBParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html) .

      Returns:
      this
    • dbParameterGroupName

      @Stability(Stable) public CfnDBParameterGroupProps.Builder dbParameterGroupName(String dbParameterGroupName)
      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)
      Parameters:
      parameters - An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional.

      RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID ( rds.ibm_customer_id ) and site number ( rds.ibm_site_id ) before starting a Db2 instance.

      For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see Working with DB Parameter Groups in the Amazon RDS User Guide .

      For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see Working with DB Parameter Groups and DB Cluster 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)
      Parameters:
      tags - An optional array of key-value pairs to apply to this DB parameter group.

      Currently, this is the only property that supports drift detection.

      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