Package software.amazon.awssdk.services.rds.model

Interface CreateDbClusterParameterGroupRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateDbClusterParameterGroupRequest.Builder,CreateDbClusterParameterGroupRequest>, RdsRequest.Builder, SdkBuilder<CreateDbClusterParameterGroupRequest.Builder,CreateDbClusterParameterGroupRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateDbClusterParameterGroupRequest
public static interface CreateDbClusterParameterGroupRequest.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<CreateDbClusterParameterGroupRequest.Builder,CreateDbClusterParameterGroupRequest>

  • Method Details

    • dbClusterParameterGroupName

      CreateDbClusterParameterGroupRequest.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.

      This value is stored as a lowercase string.

      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:
      Returns a reference to this object so that method calls can be chained together.

    • dbParameterGroupFamily

      CreateDbClusterParameterGroupRequest.Builder dbParameterGroupFamily(String dbParameterGroupFamily)

      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 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

      Parameters:
      dbParameterGroupFamily - 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 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:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateDbClusterParameterGroupRequest.Builder description(String description)

      The description for the DB cluster parameter group.

      Parameters:
      description - The description for the DB cluster parameter group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateDbClusterParameterGroupRequest.Builder tags(Collection<Tag> tags)

      Tags to assign to the DB cluster parameter group.

      Parameters:
      tags - Tags to assign to the DB cluster parameter group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateDbClusterParameterGroupRequest.Builder tags(Tag... tags)

      Tags to assign to the DB cluster parameter group.

      Parameters:
      tags - Tags to assign to the DB cluster parameter group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateDbClusterParameterGroupRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Tags to assign to the DB cluster parameter group.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateDbClusterParameterGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateDbClusterParameterGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.