AWS v6.77.0, Apr 9 25

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

aws.rds.ParameterGroup

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

Import

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

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

Create ParameterGroup Resource

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

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

TypeScript
Python
Go
C#
Java
YAML

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",
        },
    },
    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"),
		},
	},
	SkipDestroy: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

var exampleparameterGroupResourceResourceFromRdsparameterGroup = new ParameterGroup("exampleparameterGroupResourceResourceFromRdsparameterGroup", ParameterGroupArgs.builder()
    .family("string")
    .description("string")
    .name("string")
    .namePrefix("string")
    .parameters(ParameterGroupParameterArgs.builder()
        .name("string")
        .value("string")
        .applyMethod("string")
        .build())
    .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",
    }],
    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",
    }],
    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
    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.
SkipDestroy bool
Tags Dictionary<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.

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.
SkipDestroy bool
Tags 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.

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.
skipDestroy Boolean
tags 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.

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.
skipDestroy boolean
tags {[key: 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.

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.
skip_destroy bool
tags Mapping[str, str]: 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.

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.
skipDestroy Boolean
tags Map<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.

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 default_tags configuration block.
Deprecated: Please use tags instead.

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 default_tags configuration block.
Deprecated: Please use tags instead.

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 default_tags configuration block.
Deprecated: Please use tags instead.

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 default_tags configuration block.
Deprecated: Please use tags instead.

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 default_tags configuration block.
Deprecated: Please use tags instead.

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 default_tags configuration block.
Deprecated: Please use tags instead.

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.

TypeScript
Python
Go
C#
Java
YAML

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,
        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.
SkipDestroy bool
Tags Dictionary<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.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

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.
SkipDestroy bool
Tags 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.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

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.
skipDestroy Boolean
tags 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.
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

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.
skipDestroy boolean
tags {[key: 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.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

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.
skip_destroy bool
tags Mapping[str, str]: 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.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

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.
skipDestroy Boolean
tags Map<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.
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

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.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

pulumi/pulumi-aws

aws.rds.ParameterGroup

On this page

On this page

Import

Create ParameterGroup Resource

Constructor syntax

Parameters

Constructor example

ParameterGroup Resource Properties

Inputs

Outputs

Look up Existing ParameterGroup Resource

Supporting Types

ParameterGroupParameter
, ParameterGroupParameterArgs

Package Details

On this page

On this page

aws.rds.ParameterGroup

On this page

On this page

Import

Create ParameterGroup Resource

Constructor syntax

Parameters

Constructor example

ParameterGroup Resource Properties

Inputs

Outputs

Look up Existing ParameterGroup Resource

Supporting Types

ParameterGroupParameter, ParameterGroupParameterArgs

Package Details

On this page

On this page

ParameterGroupParameter
, ParameterGroupParameterArgs