Class ClusterParameterGroup

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

• Aurora MySQL Parameters
• Aurora PostgreSQL Parameters

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",
            },
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

ClusterParameterGroup

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Rds

Assembly: Pulumi.Aws.dll

Syntax

public class ClusterParameterGroup : CustomResource

Constructors

ClusterParameterGroup(String, ClusterParameterGroupArgs, CustomResourceOptions)

Create a ClusterParameterGroup resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ClusterParameterGroupArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

The ARN of the db cluster parameter group.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

Description

The description of the DB cluster parameter group. Defaults to "Managed by Pulumi".

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Family

The family of the DB cluster parameter group.

Declaration

public Output<string> Family { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the DB parameter.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NamePrefix

Creates a unique name beginning with the specified prefix. Conflicts with name.

Declaration

public Output<string> NamePrefix { get; }

Property Value

Type	Description
Output<System.String>

Parameters

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.

Declaration

public Output<ImmutableArray<ClusterParameterGroupParameter>> Parameters { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ClusterParameterGroupParameter>>

Tags

A map of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

Get(String, Input<String>, ClusterParameterGroupState, CustomResourceOptions)

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

Declaration

public static ClusterParameterGroup Get(string name, Input<string> id, ClusterParameterGroupState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ClusterParameterGroupState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ClusterParameterGroup