ClusterParameterGroup class

Manages a DocumentDB Cluster Parameter Group

Example Usage

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

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

example = aws.docdb.ClusterParameterGroup("example",
    parameters=[{
        "name": "tls",
        "value": "enabled",
    }],
    family="docdb3.6",
    name="example",
    description="docdb cluster parameter group")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.DocDB.ClusterParameterGroup("example", new()
    {
        Parameters = new[]
        {
            new Aws.DocDB.Inputs.ClusterParameterGroupParameterArgs
            {
                Name = "tls",
                Value = "enabled",
            },
        },
        Family = "docdb3.6",
        Name = "example",
        Description = "docdb cluster parameter group",
    });

});
package main

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

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

resource "aws_docdb_clusterparametergroup" "example" {
  parameters {
    name  = "tls"
    value = "enabled"
  }
  family      = "docdb3.6"
  name        = "example"
  description = "docdb cluster parameter group"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.docdb.ClusterParameterGroup;
import com.pulumi.aws.docdb.ClusterParameterGroupArgs;
import com.pulumi.aws.docdb.inputs.ClusterParameterGroupParameterArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var example = new ClusterParameterGroup("example", ClusterParameterGroupArgs.builder()
            .parameters(ClusterParameterGroupParameterArgs.builder()
                .name("tls")
                .value("enabled")
                .build())
            .family("docdb3.6")
            .name("example")
            .description("docdb cluster parameter group")
            .build());

    }
}
resources:
  example:
    type: aws:docdb:ClusterParameterGroup
    properties:
      parameters:
        - name: tls
          value: enabled
      family: docdb3.6
      name: example
      description: docdb cluster parameter group

Import

Using pulumi import, import DocumentDB Cluster Parameter Groups using the name. For example:

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

Constructors

ClusterParameterGroup(String name, {ClusterParameterGroupArgs? args, CustomResourceOptions? options})
Creates a new ClusterParameterGroup. name The Pulumi resource name. args Arguments used to configure this ClusterParameterGroup. The set of arguments for ClusterParameterGroup. options Resource options controlling this resource's behavior.
ClusterParameterGroup.reference(String urn)
Creates a typed reference to an existing ClusterParameterGroup resource.

Properties

arn ↔ Output<String>
The ARN of the DocumentDB cluster parameter group.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
description ↔ Output<String?>
The description of the DocumentDB cluster parameter group. Defaults to "Managed by Pulumi".
latefinal
family ↔ Output<String>
The family of the DocumentDB cluster parameter group.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
The name of the DocumentDB parameter.
latefinal
namePrefix ↔ Output<String>
Creates a unique name beginning with the specified prefix. Conflicts with name.
latefinal
parameters ↔ Output<List<ClusterParameterGroupParameter>?>
A list of DocumentDB parameters to apply. Setting parameters to system default values may show a difference on imported resources.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
A map of tags to assign to the resource. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ClusterParameterGroupState? state, CustomResourceOptions? options}) → ClusterParameterGroup
Gets an existing ClusterParameterGroup resource's state with the given name and id.