ParameterGroup class

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: If you encounter a pulumi preview showing parameter changes after an apply (i.e., perpetual diffs), see the Problematic Plan Changes example below for additional guidance.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

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

default = aws.rds.ParameterGroup("default",
    parameters=[
        {
            "name": "character_set_server",
            "value": "utf8",
        },
        {
            "name": "character_set_client",
            "value": "utf8",
        },
    ],
    name="rds-pg",
    family="mysql5.6")
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()
    {
        Parameters = new[]
        {
            new Aws.Rds.Inputs.ParameterGroupParameterArgs
            {
                Name = "character_set_server",
                Value = "utf8",
            },
            new Aws.Rds.Inputs.ParameterGroupParameterArgs
            {
                Name = "character_set_client",
                Value = "utf8",
            },
        },
        Name = "rds-pg",
        Family = "mysql5.6",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			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"),
				},
			},
			Name:   pulumi.String("rds-pg"),
			Family: pulumi.String("mysql5.6"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_rds_parametergroup" "default" {
  parameters {
    name  = "character_set_server"
    value = "utf8"
  }
  parameters {
    name  = "character_set_client"
    value = "utf8"
  }
  name   = "rds-pg"
  family = "mysql5.6"
}
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.ArrayList;
import java.util.Arrays;
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()
            .parameters(
                ParameterGroupParameterArgs.builder()
                    .name("character_set_server")
                    .value("utf8")
                    .build(),
                ParameterGroupParameterArgs.builder()
                    .name("character_set_client")
                    .value("utf8")
                    .build())
            .name("rds-pg")
            .family("mysql5.6")
            .build());

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

Example of Problematic Configuration

The following Terraform configuration includes a parameter that overlaps with an AWS default parameter, using the same name (defaultPasswordLifetime) and value (0). However:

  • AWS sets the default applyMethod for this parameter to pending-reboot.
  • The AWS Provider defaults all parameters' applyMethod to immediate.

This configuration attempts to change only the applyMethod from pending-reboot to immediate, which is not allowed by AWS.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.rds.ParameterGroup("test", {
    parameters: [{
        name: "default_password_lifetime",
        value: "0",
    }],
    name: "random-test-parameter",
    family: "mysql5.7",
});
import pulumi
import pulumi_aws as aws

test = aws.rds.ParameterGroup("test",
    parameters=[{
        "name": "default_password_lifetime",
        "value": "0",
    }],
    name="random-test-parameter",
    family="mysql5.7")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = new Aws.Rds.ParameterGroup("test", new()
    {
        Parameters = new[]
        {
            new Aws.Rds.Inputs.ParameterGroupParameterArgs
            {
                Name = "default_password_lifetime",
                Value = "0",
            },
        },
        Name = "random-test-parameter",
        Family = "mysql5.7",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds.NewParameterGroup(ctx, "test", &rds.ParameterGroupArgs{
			Parameters: rds.ParameterGroupParameterArray{
				&rds.ParameterGroupParameterArgs{
					Name:  pulumi.String("default_password_lifetime"),
					Value: pulumi.String("0"),
				},
			},
			Name:   pulumi.String("random-test-parameter"),
			Family: pulumi.String("mysql5.7"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_rds_parametergroup" "test" {
  parameters {
    name  = "default_password_lifetime"
    value = "0"
  }
  # By default, the apply_method is being set to "immediate"
  # same as AWS default
  name   = "random-test-parameter"
  family = "mysql5.7"
}
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.ArrayList;
import java.util.Arrays;
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 test = new ParameterGroup("test", ParameterGroupArgs.builder()
            .parameters(ParameterGroupParameterArgs.builder()
                .name("default_password_lifetime")
                .value("0")
                .build())
            .name("random-test-parameter")
            .family("mysql5.7")
            .build());

    }
}
resources:
  test:
    type: aws:rds:ParameterGroup
    properties:
      parameters:
        - name: default_password_lifetime
          value: '0'
      name: random-test-parameter
      family: mysql5.7

Solution 1: Remove the Default Parameter

Exclude the default parameter, such as defaultPasswordLifetime in this example, from your configuration entirely. This ensures Terraform does not attempt to modify the parameter, leaving it with AWS's default settings.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.rds.ParameterGroup("test", {
    name: "random-test-parameter",
    family: "mysql5.7",
});
import pulumi
import pulumi_aws as aws

test = aws.rds.ParameterGroup("test",
    name="random-test-parameter",
    family="mysql5.7")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = new Aws.Rds.ParameterGroup("test", new()
    {
        Name = "random-test-parameter",
        Family = "mysql5.7",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds.NewParameterGroup(ctx, "test", &rds.ParameterGroupArgs{
			Name:   pulumi.String("random-test-parameter"),
			Family: pulumi.String("mysql5.7"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_rds_parametergroup" "test" {
  name   = "random-test-parameter"
  family = "mysql5.7"
}
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 java.util.ArrayList;
import java.util.Arrays;
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 test = new ParameterGroup("test", ParameterGroupArgs.builder()
            .name("random-test-parameter")
            .family("mysql5.7")
            .build());

    }
}
resources:
  test:
    type: aws:rds:ParameterGroup
    properties:
      name: random-test-parameter
      family: mysql5.7

Solution 2: Modify the Parameter's Value Also

Change the value of the parameter along with its applyMethod. Since the AWS default value is 0, selecting any other valid value (e.g., 1) will resolve the issue.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.rds.ParameterGroup("test", {
    parameters: [{
        name: "default_password_lifetime",
        value: "1",
    }],
    name: "random-test-parameter",
    family: "mysql5.7",
});
import pulumi
import pulumi_aws as aws

test = aws.rds.ParameterGroup("test",
    parameters=[{
        "name": "default_password_lifetime",
        "value": "1",
    }],
    name="random-test-parameter",
    family="mysql5.7")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = new Aws.Rds.ParameterGroup("test", new()
    {
        Parameters = new[]
        {
            new Aws.Rds.Inputs.ParameterGroupParameterArgs
            {
                Name = "default_password_lifetime",
                Value = "1",
            },
        },
        Name = "random-test-parameter",
        Family = "mysql5.7",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds.NewParameterGroup(ctx, "test", &rds.ParameterGroupArgs{
			Parameters: rds.ParameterGroupParameterArray{
				&rds.ParameterGroupParameterArgs{
					Name:  pulumi.String("default_password_lifetime"),
					Value: pulumi.String("1"),
				},
			},
			Name:   pulumi.String("random-test-parameter"),
			Family: pulumi.String("mysql5.7"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_rds_parametergroup" "test" {
  parameters {
    name  = "default_password_lifetime"
    value = "1"
  }
  # Because of the default, the apply_method will also be changed from `pending-reboot` to `immediate`
  # same as AWS default
  name   = "random-test-parameter"
  family = "mysql5.7"
}
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.ArrayList;
import java.util.Arrays;
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 test = new ParameterGroup("test", ParameterGroupArgs.builder()
            .parameters(ParameterGroupParameterArgs.builder()
                .name("default_password_lifetime")
                .value("1")
                .build())
            .name("random-test-parameter")
            .family("mysql5.7")
            .build());

    }
}
resources:
  test:
    type: aws:rds:ParameterGroup
    properties:
      parameters:
        - name: default_password_lifetime
          value: '1'
      name: random-test-parameter
      family: mysql5.7

Solution 3: Align applyMethod with AWS Defaults

Explicitly set the applyMethod to match AWS's default value for this parameter (pending-reboot). This prevents conflicts between Terraform's default (immediate) and AWS's default where the value is not changing.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.rds.ParameterGroup("test", {
    parameters: [{
        applyMethod: "pending-reboot",
        name: "default_password_lifetime",
        value: "0",
    }],
    name: "random-test-parameter",
    family: "mysql5.7",
});
import pulumi
import pulumi_aws as aws

test = aws.rds.ParameterGroup("test",
    parameters=[{
        "apply_method": "pending-reboot",
        "name": "default_password_lifetime",
        "value": "0",
    }],
    name="random-test-parameter",
    family="mysql5.7")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = new Aws.Rds.ParameterGroup("test", new()
    {
        Parameters = new[]
        {
            new Aws.Rds.Inputs.ParameterGroupParameterArgs
            {
                ApplyMethod = "pending-reboot",
                Name = "default_password_lifetime",
                Value = "0",
            },
        },
        Name = "random-test-parameter",
        Family = "mysql5.7",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds.NewParameterGroup(ctx, "test", &rds.ParameterGroupArgs{
			Parameters: rds.ParameterGroupParameterArray{
				&rds.ParameterGroupParameterArgs{
					ApplyMethod: pulumi.String("pending-reboot"),
					Name:        pulumi.String("default_password_lifetime"),
					Value:       pulumi.String("0"),
				},
			},
			Name:   pulumi.String("random-test-parameter"),
			Family: pulumi.String("mysql5.7"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_rds_parametergroup" "test" {
  parameters {
    apply_method = "pending-reboot"
    name         = "default_password_lifetime"
    value        = "0"
  }
  # same as AWS default
  # same as AWS default
  name   = "random-test-parameter"
  family = "mysql5.7"
}
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.ArrayList;
import java.util.Arrays;
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 test = new ParameterGroup("test", ParameterGroupArgs.builder()
            .parameters(ParameterGroupParameterArgs.builder()
                .applyMethod("pending-reboot")
                .name("default_password_lifetime")
                .value("0")
                .build())
            .name("random-test-parameter")
            .family("mysql5.7")
            .build());

    }
}
resources:
  test:
    type: aws:rds:ParameterGroup
    properties:
      parameters:
        - applyMethod: pending-reboot
          name: default_password_lifetime
          value: '0'
      name: random-test-parameter
      family: mysql5.7

Import

Identity Schema

Required

  • name (String) Name of the DB parameter group.

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

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

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

Constructors

ParameterGroup(String name, {ParameterGroupArgs? args, CustomResourceOptions? options})
Creates a new ParameterGroup. name The Pulumi resource name. args Arguments used to configure this ParameterGroup. The set of arguments for ParameterGroup. options Resource options controlling this resource's behavior.
ParameterGroup.reference(String urn)
Creates a typed reference to an existing ParameterGroup resource.

Properties

arn ↔ Output<String>
The ARN of the db parameter group.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
description ↔ Output<String>
The description of the DB parameter group. Defaults to "Managed by Pulumi".
latefinal
family ↔ Output<String>
The family of the DB parameter group.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
The name of the DB parameter group. If omitted, this provider will assign a random, unique name.
latefinal
namePrefix ↔ Output<String>
Creates a unique name beginning with the specified prefix. Conflicts with name.
latefinal
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.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
skipDestroy ↔ Output<bool?>
Set to true if you do not wish the parameter group to be deleted at destroy time, and instead just remove the parameter group from the Terraform state.
latefinal
tags ↔ Output<Map<String, String>?>
A map of tags to assign to the resource. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ParameterGroupState? state, CustomResourceOptions? options}) → ParameterGroup
Gets an existing ParameterGroup resource's state with the given name and id.