ParameterGroup

class ParameterGroup : KotlinCustomResource

Provides an RDS DB parameter group resource. Documentation of the available parameters for various RDS engines can be found at:

NOTE: After applying your changes, you may encounter a perpetual diff in your preview output for a parameter whose value remains unchanged but whose apply_method is changing (e.g., from immediate to pending-reboot, or pending-reboot to immediate). If only the apply method of a parameter is changing, the AWS API will not register this change. To change the apply_method of a parameter, its value must also change.

Example Usage

Basic Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.ParameterGroup;
import com.pulumi.aws.rds.ParameterGroupArgs;
import com.pulumi.aws.rds.inputs.ParameterGroupParameterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var default_ = new ParameterGroup("default", ParameterGroupArgs.builder()
.family("mysql5.6")
.parameters(
ParameterGroupParameterArgs.builder()
.name("character_set_server")
.value("utf8")
.build(),
ParameterGroupParameterArgs.builder()
.name("character_set_client")
.value("utf8")
.build())
.build());
}
}

create_before_destroy Lifecycle Configuration

The create_before_destroy lifecycle configuration is necessary for modifications that force re-creation of an existing, in-use parameter group. This includes common situations like changing the group name or bumping the family version during a major version upgrade. This configuration will prevent destruction of the deposed parameter group while still in use by the database during upgrade.

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.ParameterGroup;
import com.pulumi.aws.rds.ParameterGroupArgs;
import com.pulumi.aws.rds.inputs.ParameterGroupParameterArgs;
import com.pulumi.aws.rds.Instance;
import com.pulumi.aws.rds.InstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleParameterGroup = new ParameterGroup("exampleParameterGroup", ParameterGroupArgs.builder()
.family("postgres13")
.parameters(ParameterGroupParameterArgs.builder()
.name("log_connections")
.value("1")
.build())
.build());
var exampleInstance = new Instance("exampleInstance", InstanceArgs.builder()
.parameterGroupName(exampleParameterGroup.name())
.applyImmediately(true)
.build());
}
}

Import

DB Parameter groups can be imported using the name, e.g.,

$ pulumi import aws:rds/parameterGroup:ParameterGroup rds_pg rds-pg

Properties

Link copied to clipboard
val arn: Output<String>

The ARN of the db parameter group.

Link copied to clipboard
val description: Output<String>

The description of the DB parameter group. Defaults to "Managed by Pulumi".

Link copied to clipboard
val family: Output<String>

The family of the DB parameter group.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val name: Output<String>

The name of the DB parameter.

Link copied to clipboard
val namePrefix: Output<String>

Creates a unique name beginning with the specified prefix. Conflicts with name.

Link copied to clipboard

A list of DB parameters to apply. Note that parameters may differ from a family to an other. Full list of all parameters can be discovered via aws rds describe-db-parameters after initial creation of the group.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val tags: Output<Map<String, String>>?

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Link copied to clipboard
val urn: Output<String>