AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

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/v5/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new ClusterParameterGroup("default", ClusterParameterGroupArgs.builder()        
            .description("RDS default cluster parameter group")
            .family("aurora5.6")
            .parameters(            
                ClusterParameterGroupParameterArgs.builder()
                    .name("character_set_server")
                    .value("utf8")
                    .build(),
                ClusterParameterGroupParameterArgs.builder()
                    .name("character_set_client")
                    .value("utf8")
                    .build())
            .build());

    }
}
import pulumi
import pulumi_aws as aws

default = aws.rds.ClusterParameterGroup("default",
    description="RDS default cluster parameter group",
    family="aurora5.6",
    parameters=[
        aws.rds.ClusterParameterGroupParameterArgs(
            name="character_set_server",
            value="utf8",
        ),
        aws.rds.ClusterParameterGroupParameterArgs(
            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",
        },
    ],
});
resources:
  default:
    type: aws:rds:ClusterParameterGroup
    properties:
      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);
@overload
def ClusterParameterGroup(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          description: Optional[str] = None,
                          family: Optional[str] = None,
                          name: Optional[str] = None,
                          name_prefix: Optional[str] = None,
                          parameters: Optional[Sequence[ClusterParameterGroupParameterArgs]] = None,
                          tags: Optional[Mapping[str, str]] = None)
@overload
def ClusterParameterGroup(resource_name: str,
                          args: ClusterParameterGroupArgs,
                          opts: Optional[ResourceOptions] = None)
func NewClusterParameterGroup(ctx *Context, name string, args ClusterParameterGroupArgs, opts ...ResourceOption) (*ClusterParameterGroup, error)
public ClusterParameterGroup(string name, ClusterParameterGroupArgs args, CustomResourceOptions? opts = null)
public ClusterParameterGroup(String name, ClusterParameterGroupArgs args)
public ClusterParameterGroup(String name, ClusterParameterGroupArgs args, CustomResourceOptions options)
type: aws:rds:ClusterParameterGroup
properties: # The arguments to resource properties.
options: # 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.
resource_name str
The unique name of the resource.
args ClusterParameterGroupArgs
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 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.
name String
The unique name of the resource.
args ClusterParameterGroupArgs
The arguments to resource properties.
options 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 Architecture and Concepts 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. .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 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 []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 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 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 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 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 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 {[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 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 Sequence[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 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 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<Property Map>

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>

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

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider .

Arn string

The ARN of the db cluster 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 .

arn String

The ARN of the db cluster 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 .

arn string

The ARN of the db cluster 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 .

arn str

The ARN of the db cluster 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 .

arn String

The ARN of the db cluster 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 .

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
@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[ClusterParameterGroupParameterArgs]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ClusterParameterGroup
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)
public static ClusterParameterGroup get(String name, Output<String> id, ClusterParameterGroupState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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 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. .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 .

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 []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 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 .

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

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 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 {[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 .

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 Sequence[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 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 .

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

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>

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 .

Supporting Types

ClusterParameterGroupParameter

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

RDS Cluster Parameter Groups can be imported using the name, e.g.,

 $ pulumi import aws:rds/clusterParameterGroup:ClusterParameterGroup cluster_pg production-pg-1

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.