ClusterParameterGroup

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

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var @default = new Aws.Rds.ClusterParameterGroup("default", new Aws.Rds.ClusterParameterGroupArgs
        {
            Description = "RDS default cluster parameter group",
            Family = "aurora5.6",
            Parameters = 
            {
                new Aws.Rds.Inputs.ClusterParameterGroupParameterArgs
                {
                    Name = "character_set_server",
                    Value = "utf8",
                },
                new Aws.Rds.Inputs.ClusterParameterGroupParameterArgs
                {
                    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.NewClusterParameterGroup(ctx, "_default", &rds.ClusterParameterGroupArgs{
            Description: pulumi.String("RDS default cluster parameter group"),
            Family:      pulumi.String("aurora5.6"),
            Parameters: rds.ClusterParameterGroupParameterArray{
                &rds.ClusterParameterGroupParameterArgs{
                    Name:  pulumi.String("character_set_server"),
                    Value: pulumi.String("utf8"),
                },
                &rds.ClusterParameterGroupParameterArgs{
                    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.ClusterParameterGroup("default",
    description="RDS default cluster parameter group",
    family="aurora5.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 defaultClusterParameterGroup = new aws.rds.ClusterParameterGroup("default", {
    description: "RDS default cluster parameter group",
    family: "aurora5.6",
    parameters: [
        {
            name: "character_set_server",
            value: "utf8",
        },
        {
            name: "character_set_client",
            value: "utf8",
        },
    ],
});

Create a ClusterParameterGroup Resource

new ClusterParameterGroup(name: string, args: ClusterParameterGroupArgs, opts?: CustomResourceOptions);

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

func NewClusterParameterGroup(ctx *Context, name string, args ClusterParameterGroupArgs, opts ...ResourceOption) (*ClusterParameterGroup, error)

public ClusterParameterGroup(string name, ClusterParameterGroupArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ClusterParameterGroupArgs: 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 ClusterParameterGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClusterParameterGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ClusterParameterGroup Resource Properties

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

Inputs

The ClusterParameterGroup resource accepts the following input properties:

Family string: The family of the DB cluster parameter group.
Description string: The description of the DB cluster 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<ClusterParameterGroupParameterArgs>: 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-cluster-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 cluster parameter group.
Description string: The description of the DB cluster 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 []ClusterParameterGroupParameter: 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-cluster-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 cluster parameter group.
description string: The description of the DB cluster 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 ClusterParameterGroupParameter[]: 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-cluster-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 cluster parameter group.
description str: The description of the DB cluster 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[ClusterParameterGroupParameter]: 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-cluster-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 ClusterParameterGroup resource produces the following output properties:

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

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

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

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

Look up an Existing ClusterParameterGroup Resource

Get an existing ClusterParameterGroup 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?: ClusterParameterGroupState, opts?: CustomResourceOptions): ClusterParameterGroup

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 GetClusterParameterGroup(ctx *Context, name string, id IDInput, state *ClusterParameterGroupState, opts ...ResourceOption) (*ClusterParameterGroup, error)

public static ClusterParameterGroup Get(string name, Input<string> id, ClusterParameterGroupState? 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 cluster parameter group.
Description string: The description of the DB cluster parameter group. Defaults to “Managed by Pulumi”.
Family string: The family of the DB cluster 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<ClusterParameterGroupParameterArgs>: 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-cluster-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 cluster parameter group.
Description string: The description of the DB cluster parameter group. Defaults to “Managed by Pulumi”.
Family string: The family of the DB cluster 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 []ClusterParameterGroupParameter: 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-cluster-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 cluster parameter group.
description string: The description of the DB cluster parameter group. Defaults to “Managed by Pulumi”.
family string: The family of the DB cluster 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 ClusterParameterGroupParameter[]: 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-cluster-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 cluster parameter group.
description str: The description of the DB cluster parameter group. Defaults to “Managed by Pulumi”.
family str: The family of the DB cluster 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[ClusterParameterGroupParameter]: 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-cluster-parameters after initial creation of the group.
tags Dict[str, str]: A map of tags to assign to the resource.

Supporting Types

ClusterParameterGroupParameter

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