pulumi-aws-kotlin/com.pulumi.aws.rds.kotlin/ParameterGroup

ParameterGroup

class ParameterGroup : KotlinCustomResource

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

Hands-on: For an example of the aws.rds.ParameterGroup in use, follow the Manage AWS RDS Instances tutorial on HashiCorp Learn. NOTE: to make diffs less confusing, the AWS provider will ignore changes 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). This matches the cloud: 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

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const _default = new aws.rds.ParameterGroup("default", {
    name: "rds-pg",
    family: "mysql5.6",
    parameters: [
        {
            name: "character_set_server",
            value: "utf8",
        },
        {
            name: "character_set_client",
            value: "utf8",
        },
    ],
});

import pulumi
import pulumi_aws as aws
default = aws.rds.ParameterGroup("default",
    name="rds-pg",
    family="mysql5.6",
    parameters=[
        aws.rds.ParameterGroupParameterArgs(
            name="character_set_server",
            value="utf8",
        ),
        aws.rds.ParameterGroupParameterArgs(
            name="character_set_client",
            value="utf8",
        ),
    ])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var @default = new Aws.Rds.ParameterGroup("default", new()
    {
        Name = "rds-pg",
        Family = "mysql5.6",
        Parameters = new[]
        {
            new Aws.Rds.Inputs.ParameterGroupParameterArgs
            {
                Name = "character_set_server",
                Value = "utf8",
            },
            new Aws.Rds.Inputs.ParameterGroupParameterArgs
            {
                Name = "character_set_client",
                Value = "utf8",
            },
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds.NewParameterGroup(ctx, "default", &rds.ParameterGroupArgs{
			Name:   pulumi.String("rds-pg"),
			Family: pulumi.String("mysql5.6"),
			Parameters: rds.ParameterGroupParameterArray{
				&rds.ParameterGroupParameterArgs{
					Name:  pulumi.String("character_set_server"),
					Value: pulumi.String("utf8"),
				},
				&rds.ParameterGroupParameterArgs{
					Name:  pulumi.String("character_set_client"),
					Value: pulumi.String("utf8"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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()
            .name("rds-pg")
            .family("mysql5.6")
            .parameters(
                ParameterGroupParameterArgs.builder()
                    .name("character_set_server")
                    .value("utf8")
                    .build(),
                ParameterGroupParameterArgs.builder()
                    .name("character_set_client")
                    .value("utf8")
                    .build())
            .build());
    }
}

resources:
  default:
    type: aws:rds:ParameterGroup
    properties:
      name: rds-pg
      family: mysql5.6
      parameters:
        - name: character_set_server
          value: utf8
        - name: character_set_client
          value: utf8

Import

Using pulumi import, import DB Parameter groups using the name. For example:

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

Properties

arn

val arn: Output<String>

The ARN of the db parameter group.

description

val description: Output<String>

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

family

val family: Output<String>

The family of the DB parameter group.

val id: Output<String>

name

val name: Output<String>

The name of the DB parameter group. If omitted, this provider will assign a random, unique name.

namePrefix

val namePrefix: Output<String>

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

parameters

val parameters: Output<List<ParameterGroupParameter>>?

The DB parameters to apply. See parameter Block below for more details. 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.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String