ClusterParameterGroup class
Provides an RDS DB cluster parameter group resource. Documentation of the available parameters for various Aurora engines can be found at:
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const _default = new aws.rds.ClusterParameterGroup("default", {
parameters: [
{
name: "character_set_server",
value: "utf8",
},
{
name: "character_set_client",
value: "utf8",
},
],
name: "rds-cluster-pg",
family: "aurora5.6",
description: "RDS default cluster parameter group",
});
import pulumi
import pulumi_aws as aws
default = aws.rds.ClusterParameterGroup("default",
parameters=[
{
"name": "character_set_server",
"value": "utf8",
},
{
"name": "character_set_client",
"value": "utf8",
},
],
name="rds-cluster-pg",
family="aurora5.6",
description="RDS default cluster parameter group")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var @default = new Aws.Rds.ClusterParameterGroup("default", new()
{
Parameters = new[]
{
new Aws.Rds.Inputs.ClusterParameterGroupParameterArgs
{
Name = "character_set_server",
Value = "utf8",
},
new Aws.Rds.Inputs.ClusterParameterGroupParameterArgs
{
Name = "character_set_client",
Value = "utf8",
},
},
Name = "rds-cluster-pg",
Family = "aurora5.6",
Description = "RDS default cluster parameter group",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
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"),
},
},
Name: pulumi.String("rds-cluster-pg"),
Family: pulumi.String("aurora5.6"),
Description: pulumi.String("RDS default cluster parameter group"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_rds_clusterparametergroup" "default" {
parameters {
name = "character_set_server"
value = "utf8"
}
parameters {
name = "character_set_client"
value = "utf8"
}
name = "rds-cluster-pg"
family = "aurora5.6"
description = "RDS default cluster parameter group"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.ClusterParameterGroup;
import com.pulumi.aws.rds.ClusterParameterGroupArgs;
import com.pulumi.aws.rds.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 default_ = new ClusterParameterGroup("default", ClusterParameterGroupArgs.builder()
.parameters(
ClusterParameterGroupParameterArgs.builder()
.name("character_set_server")
.value("utf8")
.build(),
ClusterParameterGroupParameterArgs.builder()
.name("character_set_client")
.value("utf8")
.build())
.name("rds-cluster-pg")
.family("aurora5.6")
.description("RDS default cluster parameter group")
.build());
}
}
resources:
default:
type: aws:rds:ClusterParameterGroup
properties:
parameters:
- name: character_set_server
value: utf8
- name: character_set_client
value: utf8
name: rds-cluster-pg
family: aurora5.6
description: RDS default cluster parameter group
Import
Using pulumi import, import RDS Cluster Parameter Groups using the name. For example:
$ pulumi import aws:rds/clusterParameterGroup:ClusterParameterGroup cluster_pg production-pg-1
Constructors
- ClusterParameterGroup(String name, {ClusterParameterGroupArgs? args, CustomResourceOptions? options})
-
Creates a new ClusterParameterGroup.
nameThe Pulumi resource name.argsArguments used to configure this ClusterParameterGroup. The set of arguments for ClusterParameterGroup.optionsResource 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 db cluster parameter group.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String> -
The description of the DB cluster parameter group. Defaults to "Managed by Pulumi".
latefinal
-
family
↔ Output<
String> -
The family of the DB 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 DB 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 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-parametersafter initial creation of the group.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
-
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration 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
nameandid.