Package software.amazon.awscdk.services.rds

Class ParameterGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.rds.ParameterGroup
All Implemented Interfaces:
IEnvironmentAware, IDBClusterParameterGroupRef, IDBParameterGroupRef, IResource, IParameterGroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-04-02T21:55:18.194Z") @Stability(Stable) public class ParameterGroup extends Resource implements IParameterGroup
A parameter group.

Represents both a cluster parameter group (AWS::RDS::DBClusterParameterGroup), and an instance parameter group (AWS::RDS::DBParameterGroup).

Example: 

 Vpc vpc;
 ServerlessCluster cluster = ServerlessCluster.Builder.create(this, "AnotherCluster")
         .engine(DatabaseClusterEngine.AURORA_POSTGRESQL)
         .copyTagsToSnapshot(true) // whether to save the cluster tags when creating the snapshot. Default is 'true'
         .parameterGroup(ParameterGroup.fromParameterGroupName(this, "ParameterGroup", "default.aurora-postgresql11"))
         .vpc(vpc)
         .scaling(ServerlessScalingOptions.builder()
                 .autoPause(Duration.minutes(10)) // default is to pause after 5 minutes of idle time
                 .minCapacity(AuroraCapacityUnit.ACU_8) // default is 2 Aurora capacity units (ACUs)
                 .maxCapacity(AuroraCapacityUnit.ACU_32) // default is 16 Aurora capacity units (ACUs)
                 .timeout(Duration.seconds(100)) // default is 5 minutes
                 .timeoutAction(TimeoutAction.FORCE_APPLY_CAPACITY_CHANGE)
                 .build())
         .build();

  • Field Details

    • PROPERTY_INJECTION_ID

      @Stability(Stable) public static final String PROPERTY_INJECTION_ID
      Uniquely identifies this class.

  • Constructor Details

    • ParameterGroup

      protected ParameterGroup(software.amazon.jsii.JsiiObjectRef objRef)

    • ParameterGroup

      protected ParameterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • ParameterGroup

      @Stability(Stable) public ParameterGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ParameterGroupProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • forCluster

      @Stability(Stable) @NotNull public static IParameterGroup forCluster(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ParameterGroupProps props)
      Creates a standalone cluster parameter group.

      This method allows you to explicitly create a parameter group without binding it to a database cluster.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.
      Returns:
      cluster parameter group (AWS::RDS::DBClusterParameterGroup)

    • forInstance

      @Stability(Stable) @NotNull public static IParameterGroup forInstance(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ParameterGroupProps props)
      Creates a standalone instance parameter group.

      This method allows you to explicitly create a parameter group without binding it to a database instance.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.
      Returns:
      instance parameter group (AWS::RDS::DBParameterGroup)

    • fromParameterGroupName

      @Stability(Stable) @NotNull public static IParameterGroup fromParameterGroupName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String parameterGroupName)
      Imports a parameter group.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      parameterGroupName - This parameter is required.

    • addParameter

      @Stability(Stable) @NotNull public Boolean addParameter(@NotNull String key, @NotNull String value)
      Add a parameter to this parameter group.

      Specified by:
      addParameter in interface IParameterGroup
      Parameters:
      key - The key of the parameter to be added. This parameter is required.
      value - The value of the parameter to be added. This parameter is required.
      Returns:
      true if the parameter was actually added (i.e., this ParameterGroup is not imported), false otherwise

    • bindToCluster

      @Stability(Stable) @NotNull public ParameterGroupClusterConfig bindToCluster(@NotNull ParameterGroupClusterBindOptions _options)
      Method called when this Parameter Group is used when defining a database cluster.

      Specified by:
      bindToCluster in interface IParameterGroup
      Parameters:
      _options - This parameter is required.

    • bindToInstance

      @Stability(Stable) @NotNull public ParameterGroupInstanceConfig bindToInstance(@NotNull ParameterGroupInstanceBindOptions _options)
      Method called when this Parameter Group is used when defining a database instance.

      Specified by:
      bindToInstance in interface IParameterGroup
      Parameters:
      _options - This parameter is required.

    • getDbClusterParameterGroupRef

      @Stability(Stable) @NotNull public DBClusterParameterGroupReference getDbClusterParameterGroupRef()
      A reference to this parameter group as a DB cluster parameter group.
      Specified by:
      getDbClusterParameterGroupRef in interface IDBClusterParameterGroupRef

    • getDbParameterGroupRef

      @Stability(Stable) @NotNull public DBParameterGroupReference getDbParameterGroupRef()
      A reference to this parameter group as a DB parameter group.
      Specified by:
      getDbParameterGroupRef in interface IDBParameterGroupRef