ClusterParameterGroup

Manages a DocumentDB Cluster Parameter Group

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.DocDB.ClusterParameterGroup("example", new Aws.DocDB.ClusterParameterGroupArgs
        {
            Description = "docdb cluster parameter group",
            Family = "docdb3.6",
            Parameters = 
            {
                new Aws.DocDB.Inputs.ClusterParameterGroupParameterArgs
                {
                    Name = "tls",
                    Value = "enabled",
                },
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/docdb"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := docdb.NewClusterParameterGroup(ctx, "example", &docdb.ClusterParameterGroupArgs{
            Description: pulumi.String("docdb cluster parameter group"),
            Family:      pulumi.String("docdb3.6"),
            Parameters: docdb.ClusterParameterGroupParameterArray{
                &docdb.ClusterParameterGroupParameterArgs{
                    Name:  pulumi.String("tls"),
                    Value: pulumi.String("enabled"),
                },
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.docdb.ClusterParameterGroup("example",
    description="docdb cluster parameter group",
    family="docdb3.6",
    parameters=[{
        "name": "tls",
        "value": "enabled",
    }])

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

const example = new aws.docdb.ClusterParameterGroup("example", {
    description: "docdb cluster parameter group",
    family: "docdb3.6",
    parameters: [{
        name: "tls",
        value: "enabled",
    }],
});

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 documentDB cluster parameter group.
Description string: The description of the documentDB cluster parameter group. Defaults to “Managed by Pulumi”.
Name string: The name of the documentDB parameter.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
Parameters List<ClusterParameterGroupParameterArgs>: A list of documentDB parameters to apply.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

Family string: The family of the documentDB cluster parameter group.
Description string: The description of the documentDB cluster parameter group. Defaults to “Managed by Pulumi”.
Name string: The name of the documentDB parameter.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
Parameters []ClusterParameterGroupParameter: A list of documentDB parameters to apply.
Tags map[string]string: A map of tags to assign to the resource.

family string: The family of the documentDB cluster parameter group.
description string: The description of the documentDB cluster parameter group. Defaults to “Managed by Pulumi”.
name string: The name of the documentDB parameter.
namePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
parameters ClusterParameterGroupParameter[]: A list of documentDB parameters to apply.
tags {[key: string]: string}: A map of tags to assign to the resource.

family str: The family of the documentDB cluster parameter group.
description str: The description of the documentDB cluster parameter group. Defaults to “Managed by Pulumi”.
name str: The name of the documentDB parameter.
name_prefix str: Creates a unique name beginning with the specified prefix. Conflicts with name.
parameters List[ClusterParameterGroupParameter]: A list of documentDB parameters to apply.
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 documentDB cluster parameter group.
Id string: The provider-assigned unique ID for this managed resource.

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

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

arn str: The ARN of the documentDB 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 documentDB cluster parameter group.
Description string: The description of the documentDB cluster parameter group. Defaults to “Managed by Pulumi”.
Family string: The family of the documentDB cluster parameter group.
Name string: The name of the documentDB parameter.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
Parameters List<ClusterParameterGroupParameterArgs>: A list of documentDB parameters to apply.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

Arn string: The ARN of the documentDB cluster parameter group.
Description string: The description of the documentDB cluster parameter group. Defaults to “Managed by Pulumi”.
Family string: The family of the documentDB cluster parameter group.
Name string: The name of the documentDB parameter.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
Parameters []ClusterParameterGroupParameter: A list of documentDB parameters to apply.
Tags map[string]string: A map of tags to assign to the resource.

arn string: The ARN of the documentDB cluster parameter group.
description string: The description of the documentDB cluster parameter group. Defaults to “Managed by Pulumi”.
family string: The family of the documentDB cluster parameter group.
name string: The name of the documentDB parameter.
namePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
parameters ClusterParameterGroupParameter[]: A list of documentDB parameters to apply.
tags {[key: string]: string}: A map of tags to assign to the resource.

arn str: The ARN of the documentDB cluster parameter group.
description str: The description of the documentDB cluster parameter group. Defaults to “Managed by Pulumi”.
family str: The family of the documentDB cluster parameter group.
name str: The name of the documentDB parameter.
name_prefix str: Creates a unique name beginning with the specified prefix. Conflicts with name.
parameters List[ClusterParameterGroupParameter]: A list of documentDB parameters to apply.
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 documentDB parameter.
Value string: The value of the documentDB parameter.
ApplyMethod string: Valid values are immediate and pending-reboot. Defaults to pending-reboot.

Name string: The name of the documentDB parameter.
Value string: The value of the documentDB parameter.
ApplyMethod string: Valid values are immediate and pending-reboot. Defaults to pending-reboot.

name string: The name of the documentDB parameter.
value string: The value of the documentDB parameter.
applyMethod string: Valid values are immediate and pending-reboot. Defaults to pending-reboot.

name str: The name of the documentDB parameter.
value str: The value of the documentDB parameter.
applyMethod str: Valid values are immediate and pending-reboot. Defaults to pending-reboot.

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