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:
IResource, IParameterGroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-24T21:00:35.317Z") @Stability(Stable) public class ParameterGroup extends Resource implements IParameterGroup
A parameter group.

Represents both a cluster parameter group, and an instance parameter group.

Example:

 BackupPlan plan;
 Vpc vpc;
 ITable myTable = Table.fromTableName(this, "Table", "myTableName");
 DatabaseInstance myDatabaseInstance = DatabaseInstance.Builder.create(this, "DatabaseInstance")
         .engine(DatabaseInstanceEngine.mysql(MySqlInstanceEngineProps.builder().version(MysqlEngineVersion.VER_8_0_26).build()))
         .vpc(vpc)
         .build();
 DatabaseCluster myDatabaseCluster = DatabaseCluster.Builder.create(this, "DatabaseCluster")
         .engine(DatabaseClusterEngine.auroraMysql(AuroraMysqlClusterEngineProps.builder().version(AuroraMysqlEngineVersion.VER_2_08_1).build()))
         .credentials(Credentials.fromGeneratedSecret("clusteradmin"))
         .instanceProps(InstanceProps.builder()
                 .vpc(vpc)
                 .build())
         .build();
 ServerlessCluster myServerlessCluster = ServerlessCluster.Builder.create(this, "ServerlessCluster")
         .engine(DatabaseClusterEngine.AURORA_POSTGRESQL)
         .parameterGroup(ParameterGroup.fromParameterGroupName(this, "ParameterGroup", "default.aurora-postgresql11"))
         .vpc(vpc)
         .build();
 Construct myCoolConstruct = new Construct(this, "MyCoolConstruct");
 plan.addSelection("Selection", BackupSelectionOptions.builder()
         .resources(List.of(BackupResource.fromDynamoDbTable(myTable), BackupResource.fromRdsDatabaseInstance(myDatabaseInstance), BackupResource.fromRdsDatabaseCluster(myDatabaseCluster), BackupResource.fromRdsServerlessCluster(myServerlessCluster), BackupResource.fromTag("stage", "prod"), BackupResource.fromConstruct(myCoolConstruct)))
         .build());
 
  • 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

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