ParameterGroup

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

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var @default = new Aws.Rds.ParameterGroup("default", new Aws.Rds.ParameterGroupArgs
        {
            Family = "mysql5.6",
            Parameters = 
            {
                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/v2/go/aws/rds"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := rds.NewParameterGroup(ctx, "_default", &rds.ParameterGroupArgs{
            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
    })
}

import pulumi
import pulumi_aws as aws

default = aws.rds.ParameterGroup("default",
    family="mysql5.6",
    parameters=[
        {
            "name": "character_set_server",
            "value": "utf8",
        },
        {
            "name": "character_set_client",
            "value": "utf8",
        },
    ])

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

const defaultParameterGroup = new aws.rds.ParameterGroup("default", {
    family: "mysql5.6",
    parameters: [
        {
            name: "character_set_server",
            value: "utf8",
        },
        {
            name: "character_set_client",
            value: "utf8",
        },
    ],
});

Create a ParameterGroup Resource

new ParameterGroup(name: string, args: ParameterGroupArgs, opts?: CustomResourceOptions);

def ParameterGroup(resource_name, opts=None, description=None, family=None, name=None, name_prefix=None, parameters=None, tags=None, __props__=None);

func NewParameterGroup(ctx *Context, name string, args ParameterGroupArgs, opts ...ResourceOption) (*ParameterGroup, error)

public ParameterGroup(string name, ParameterGroupArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

ParameterGroup Resource Properties

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

Inputs

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.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
Parameters List<ParameterGroupParameterArgs>: A list of DB parameters to apply. Note that parameters may differ from a family to an other. Full list of all parameters can be discovered via aws rds describe-db-parameters after initial creation of the group.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

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.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
Parameters []ParameterGroupParameter: A list of DB parameters to apply. Note that parameters may differ from a family to an other. Full list of all parameters can be discovered via aws rds describe-db-parameters after initial creation of the group.
Tags map[string]string: A map of tags to assign to the resource.

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.
namePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
parameters ParameterGroupParameter[]: A list of DB parameters to apply. Note that parameters may differ from a family to an other. Full list of all parameters can be discovered via aws rds describe-db-parameters after initial creation of the group.
tags {[key: string]: string}: A map of tags to assign to the resource.

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.
name_prefix str: Creates a unique name beginning with the specified prefix. Conflicts with name.
parameters List[ParameterGroupParameter]: A list of DB parameters to apply. Note that parameters may differ from a family to an other. Full list of all parameters can be discovered via aws rds describe-db-parameters after initial creation of the group.
tags Dict[str, str]: A map of tags to assign to the resource.

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.

Arn string: The ARN of the db parameter group.
Id string: The provider-assigned unique ID for this managed resource.

arn string: The ARN of the db parameter group.
id string: The provider-assigned unique ID for this managed resource.

arn str: The ARN of the db parameter group.
id str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, arn=None, description=None, family=None, name=None, name_prefix=None, parameters=None, tags=None, __props__=None);

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)

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.

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.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
Parameters List<ParameterGroupParameterArgs>: A list of DB parameters to apply. Note that parameters may differ from a family to an other. Full list of all parameters can be discovered via aws rds describe-db-parameters after initial creation of the group.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

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.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
Parameters []ParameterGroupParameter: A list of DB parameters to apply. Note that parameters may differ from a family to an other. Full list of all parameters can be discovered via aws rds describe-db-parameters after initial creation of the group.
Tags map[string]string: A map of tags to assign to the resource.

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.
namePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
parameters ParameterGroupParameter[]: A list of DB parameters to apply. Note that parameters may differ from a family to an other. Full list of all parameters can be discovered via aws rds describe-db-parameters after initial creation of the group.
tags {[key: string]: string}: A map of tags to assign to the resource.

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.
name_prefix str: Creates a unique name beginning with the specified prefix. Conflicts with name.
parameters List[ParameterGroupParameter]: A list of DB parameters to apply. Note that parameters may differ from a family to an other. Full list of all parameters can be discovered via aws rds describe-db-parameters after initial creation of the group.
tags Dict[str, str]: A map of tags to assign to the resource.

Supporting Types

ParameterGroupParameter

See the input and output API doc for this type.

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

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud