1. Packages
  2. AWS
  3. API Docs
  4. rds
  5. ParameterGroup
Viewing docs for AWS v7.24.0
published on Tuesday, Mar 31, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.rds.ParameterGroup

aws logo
Viewing docs for AWS v7.24.0
published on Tuesday, Mar 31, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    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", {
    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=[
        {
            "name": "character_set_server",
            "value": "utf8",
        },
        {
            "name": "character_set_client",
            "value": "utf8",
        },
    ])

    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{
			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
	})
}

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

    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", {
    name: "random-test-parameter",
    family: "mysql5.7",
    parameters: [{
        name: "default_password_lifetime",
        value: "0",
    }],
});

    import pulumi
import pulumi_aws as aws

test = aws.rds.ParameterGroup("test",
    name="random-test-parameter",
    family="mysql5.7",
    parameters=[{
        "name": "default_password_lifetime",
        "value": "0",
    }])

    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"),
			Parameters: rds.ParameterGroupParameterArray{
				&rds.ParameterGroupParameterArgs{
					Name:  pulumi.String("default_password_lifetime"),
					Value: pulumi.String("0"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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",
        Parameters = new[]
        {
            new Aws.Rds.Inputs.ParameterGroupParameterArgs
            {
                Name = "default_password_lifetime",
                Value = "0",
            },
        },
    });

});

    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 test = new ParameterGroup("test", ParameterGroupArgs.builder()
            .name("random-test-parameter")
            .family("mysql5.7")
            .parameters(ParameterGroupParameterArgs.builder()
                .name("default_password_lifetime")
                .value("0")
                .build())
            .build());

    }
}

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

    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")

    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
	})
}

    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 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.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 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", {
    name: "random-test-parameter",
    family: "mysql5.7",
    parameters: [{
        name: "default_password_lifetime",
        value: "1",
    }],
});

    import pulumi
import pulumi_aws as aws

test = aws.rds.ParameterGroup("test",
    name="random-test-parameter",
    family="mysql5.7",
    parameters=[{
        "name": "default_password_lifetime",
        "value": "1",
    }])

    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"),
			Parameters: rds.ParameterGroupParameterArray{
				&rds.ParameterGroupParameterArgs{
					Name:  pulumi.String("default_password_lifetime"),
					Value: pulumi.String("1"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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",
        Parameters = new[]
        {
            new Aws.Rds.Inputs.ParameterGroupParameterArgs
            {
                Name = "default_password_lifetime",
                Value = "1",
            },
        },
    });

});

    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 test = new ParameterGroup("test", ParameterGroupArgs.builder()
            .name("random-test-parameter")
            .family("mysql5.7")
            .parameters(ParameterGroupParameterArgs.builder()
                .name("default_password_lifetime")
                .value("1")
                .build())
            .build());

    }
}

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

    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", {
    name: "random-test-parameter",
    family: "mysql5.7",
    parameters: [{
        applyMethod: "pending-reboot",
        name: "default_password_lifetime",
        value: "0",
    }],
});

    import pulumi
import pulumi_aws as aws

test = aws.rds.ParameterGroup("test",
    name="random-test-parameter",
    family="mysql5.7",
    parameters=[{
        "apply_method": "pending-reboot",
        "name": "default_password_lifetime",
        "value": "0",
    }])

    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"),
			Parameters: rds.ParameterGroupParameterArray{
				&rds.ParameterGroupParameterArgs{
					ApplyMethod: pulumi.String("pending-reboot"),
					Name:        pulumi.String("default_password_lifetime"),
					Value:       pulumi.String("0"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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",
        Parameters = new[]
        {
            new Aws.Rds.Inputs.ParameterGroupParameterArgs
            {
                ApplyMethod = "pending-reboot",
                Name = "default_password_lifetime",
                Value = "0",
            },
        },
    });

});

    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 test = new ParameterGroup("test", ParameterGroupArgs.builder()
            .name("random-test-parameter")
            .family("mysql5.7")
            .parameters(ParameterGroupParameterArgs.builder()
                .applyMethod("pending-reboot")
                .name("default_password_lifetime")
                .value("0")
                .build())
            .build());

    }
}

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

    Create ParameterGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ParameterGroup(name: string, args: ParameterGroupArgs, opts?: CustomResourceOptions);
    @overload
def ParameterGroup(resource_name: str,
                   args: ParameterGroupArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ParameterGroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   family: Optional[str] = None,
                   description: Optional[str] = None,
                   name: Optional[str] = None,
                   name_prefix: Optional[str] = None,
                   parameters: Optional[Sequence[ParameterGroupParameterArgs]] = None,
                   region: Optional[str] = None,
                   skip_destroy: Optional[bool] = None,
                   tags: Optional[Mapping[str, str]] = None)
    func NewParameterGroup(ctx *Context, name string, args ParameterGroupArgs, opts ...ResourceOption) (*ParameterGroup, error)
    public ParameterGroup(string name, ParameterGroupArgs args, CustomResourceOptions? opts = null)
    public ParameterGroup(String name, ParameterGroupArgs args)
public ParameterGroup(String name, ParameterGroupArgs args, CustomResourceOptions options)

    type: aws:rds:ParameterGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ParameterGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ParameterGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ParameterGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ParameterGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ParameterGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleparameterGroupResourceResourceFromRdsparameterGroup = new Aws.Rds.ParameterGroup("exampleparameterGroupResourceResourceFromRdsparameterGroup", new()
{
    Family = "string",
    Description = "string",
    Name = "string",
    NamePrefix = "string",
    Parameters = new[]
    {
        new Aws.Rds.Inputs.ParameterGroupParameterArgs
        {
            Name = "string",
            Value = "string",
            ApplyMethod = "string",
        },
    },
    Region = "string",
    SkipDestroy = false,
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := rds.NewParameterGroup(ctx, "exampleparameterGroupResourceResourceFromRdsparameterGroup", &rds.ParameterGroupArgs{
	Family:      pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	NamePrefix:  pulumi.String("string"),
	Parameters: rds.ParameterGroupParameterArray{
		&rds.ParameterGroupParameterArgs{
			Name:        pulumi.String("string"),
			Value:       pulumi.String("string"),
			ApplyMethod: pulumi.String("string"),
		},
	},
	Region:      pulumi.String("string"),
	SkipDestroy: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var exampleparameterGroupResourceResourceFromRdsparameterGroup = new com.pulumi.aws.rds.ParameterGroup("exampleparameterGroupResourceResourceFromRdsparameterGroup", com.pulumi.aws.rds.ParameterGroupArgs.builder()
    .family("string")
    .description("string")
    .name("string")
    .namePrefix("string")
    .parameters(ParameterGroupParameterArgs.builder()
        .name("string")
        .value("string")
        .applyMethod("string")
        .build())
    .region("string")
    .skipDestroy(false)
    .tags(Map.of("string", "string"))
    .build());

    exampleparameter_group_resource_resource_from_rdsparameter_group = aws.rds.ParameterGroup("exampleparameterGroupResourceResourceFromRdsparameterGroup",
    family="string",
    description="string",
    name="string",
    name_prefix="string",
    parameters=[{
        "name": "string",
        "value": "string",
        "apply_method": "string",
    }],
    region="string",
    skip_destroy=False,
    tags={
        "string": "string",
    })

    const exampleparameterGroupResourceResourceFromRdsparameterGroup = new aws.rds.ParameterGroup("exampleparameterGroupResourceResourceFromRdsparameterGroup", {
    family: "string",
    description: "string",
    name: "string",
    namePrefix: "string",
    parameters: [{
        name: "string",
        value: "string",
        applyMethod: "string",
    }],
    region: "string",
    skipDestroy: false,
    tags: {
        string: "string",
    },
});

    type: aws:rds:ParameterGroup
properties:
    description: string
    family: string
    name: string
    namePrefix: string
    parameters:
        - applyMethod: string
          name: string
          value: string
    region: string
    skipDestroy: false
    tags:
        string: string

    ParameterGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ParameterGroup resource accepts the following input properties:

    Family string
    The family of the DB parameter group.
    Description string
    The description of the DB parameter group. Defaults to "Managed by Pulumi".
    Name string
    The name of the DB parameter group. If omitted, this provider will assign a random, unique name.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Parameters 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.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SkipDestroy 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.
    Tags Dictionary<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.
    Family string
    The family of the DB parameter group.
    Description string
    The description of the DB parameter group. Defaults to "Managed by Pulumi".
    Name string
    The name of the DB parameter group. If omitted, this provider will assign a random, unique name.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Parameters []ParameterGroupParameterArgs
    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.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SkipDestroy 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.
    Tags 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.
    family String
    The family of the DB parameter group.
    description String
    The description of the DB parameter group. Defaults to "Managed by Pulumi".
    name String
    The name of the DB parameter group. If omitted, this provider will assign a random, unique name.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters 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.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    skipDestroy Boolean
    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.
    tags 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.
    family string
    The family of the DB parameter group.
    description string
    The description of the DB parameter group. Defaults to "Managed by Pulumi".
    name string
    The name of the DB parameter group. If omitted, this provider will assign a random, unique name.
    namePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters 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.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    skipDestroy boolean
    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.
    tags {[key: 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.
    family str
    The family of the DB parameter group.
    description str
    The description of the DB parameter group. Defaults to "Managed by Pulumi".
    name str
    The name of the DB parameter group. If omitted, this provider will assign a random, unique name.
    name_prefix str
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters Sequence[ParameterGroupParameterArgs]
    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.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    skip_destroy 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.
    tags Mapping[str, str]
    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.
    family String
    The family of the DB parameter group.
    description String
    The description of the DB parameter group. Defaults to "Managed by Pulumi".
    name String
    The name of the DB parameter group. If omitted, this provider will assign a random, unique name.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters List<Property Map>
    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.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    skipDestroy Boolean
    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.
    tags Map<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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ParameterGroup resource produces the following output properties:

    Arn string
    The ARN of the db parameter group.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Arn string
    The ARN of the db parameter group.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    The ARN of the db parameter group.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn string
    The ARN of the db parameter group.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn str
    The ARN of the db parameter group.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    The ARN of the db parameter group.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

    Look up Existing ParameterGroup Resource

    Get an existing ParameterGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ParameterGroupState, opts?: CustomResourceOptions): ParameterGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        family: Optional[str] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        parameters: Optional[Sequence[ParameterGroupParameterArgs]] = None,
        region: Optional[str] = None,
        skip_destroy: Optional[bool] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ParameterGroup
    func GetParameterGroup(ctx *Context, name string, id IDInput, state *ParameterGroupState, opts ...ResourceOption) (*ParameterGroup, error)
    public static ParameterGroup Get(string name, Input<string> id, ParameterGroupState? state, CustomResourceOptions? opts = null)
    public static ParameterGroup get(String name, Output<String> id, ParameterGroupState state, CustomResourceOptions options)
    resources:  _:    type: aws:rds:ParameterGroup    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The ARN of the db parameter group.
    Description string
    The description of the DB parameter group. Defaults to "Managed by Pulumi".
    Family string
    The family of the DB parameter group.
    Name string
    The name of the DB parameter group. If omitted, this provider will assign a random, unique name.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Parameters 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.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SkipDestroy 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.
    Tags Dictionary<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.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Arn string
    The ARN of the db parameter group.
    Description string
    The description of the DB parameter group. Defaults to "Managed by Pulumi".
    Family string
    The family of the DB parameter group.
    Name string
    The name of the DB parameter group. If omitted, this provider will assign a random, unique name.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Parameters []ParameterGroupParameterArgs
    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.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SkipDestroy 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.
    Tags 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.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    The ARN of the db parameter group.
    description String
    The description of the DB parameter group. Defaults to "Managed by Pulumi".
    family String
    The family of the DB parameter group.
    name String
    The name of the DB parameter group. If omitted, this provider will assign a random, unique name.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters 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.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    skipDestroy Boolean
    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.
    tags 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.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn string
    The ARN of the db parameter group.
    description string
    The description of the DB parameter group. Defaults to "Managed by Pulumi".
    family string
    The family of the DB parameter group.
    name string
    The name of the DB parameter group. If omitted, this provider will assign a random, unique name.
    namePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters 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.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    skipDestroy boolean
    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.
    tags {[key: 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.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn str
    The ARN of the db parameter group.
    description str
    The description of the DB parameter group. Defaults to "Managed by Pulumi".
    family str
    The family of the DB parameter group.
    name str
    The name of the DB parameter group. If omitted, this provider will assign a random, unique name.
    name_prefix str
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters Sequence[ParameterGroupParameterArgs]
    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.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    skip_destroy 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.
    tags Mapping[str, str]
    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.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    The ARN of the db parameter group.
    description String
    The description of the DB parameter group. Defaults to "Managed by Pulumi".
    family String
    The family of the DB parameter group.
    name String
    The name of the DB parameter group. If omitted, this provider will assign a random, unique name.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters List<Property Map>
    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.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    skipDestroy Boolean
    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.
    tags Map<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.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

    Supporting Types

    ParameterGroupParameter, ParameterGroupParameterArgs

    Name string
    The name of the DB parameter.
    Value string
    The value of the DB parameter.
    ApplyMethod string
    "immediate" (default), or "pending-reboot". Some engines can't apply some parameters without a reboot, and you will need to specify "pending-reboot" here.
    Name string
    The name of the DB parameter.
    Value string
    The value of the DB parameter.
    ApplyMethod string
    "immediate" (default), or "pending-reboot". Some engines can't apply some parameters without a reboot, and you will need to specify "pending-reboot" here.
    name String
    The name of the DB parameter.
    value String
    The value of the DB parameter.
    applyMethod String
    "immediate" (default), or "pending-reboot". Some engines can't apply some parameters without a reboot, and you will need to specify "pending-reboot" here.
    name string
    The name of the DB parameter.
    value string
    The value of the DB parameter.
    applyMethod string
    "immediate" (default), or "pending-reboot". Some engines can't apply some parameters without a reboot, and you will need to specify "pending-reboot" here.
    name str
    The name of the DB parameter.
    value str
    The value of the DB parameter.
    apply_method str
    "immediate" (default), or "pending-reboot". Some engines can't apply some parameters without a reboot, and you will need to specify "pending-reboot" here.
    name String
    The name of the DB parameter.
    value String
    The value of the DB parameter.
    applyMethod String
    "immediate" (default), or "pending-reboot". Some engines can't apply some parameters without a reboot, and you will need to specify "pending-reboot" here.

    Import

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

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v7.24.0
    published on Tuesday, Mar 31, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws
      Try Pulumi Cloud free. Your team will thank you.