ParameterGroup class

Provides a MemoryDB Parameter Group.

More information about parameter groups can be found in the MemoryDB User Guide.

Example Usage

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

const example = new aws.memorydb.ParameterGroup("example", {
    parameters: [{
        name: "activedefrag",
        value: "yes",
    }],
    name: "my-parameter-group",
    family: "memorydb_redis6",
});
import pulumi
import pulumi_aws as aws

example = aws.memorydb.ParameterGroup("example",
    parameters=[{
        "name": "activedefrag",
        "value": "yes",
    }],
    name="my-parameter-group",
    family="memorydb_redis6")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.MemoryDb.ParameterGroup("example", new()
    {
        Parameters = new[]
        {
            new Aws.MemoryDb.Inputs.ParameterGroupParameterArgs
            {
                Name = "activedefrag",
                Value = "yes",
            },
        },
        Name = "my-parameter-group",
        Family = "memorydb_redis6",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := memorydb.NewParameterGroup(ctx, "example", &memorydb.ParameterGroupArgs{
			Parameters: memorydb.ParameterGroupParameterArray{
				&memorydb.ParameterGroupParameterArgs{
					Name:  pulumi.String("activedefrag"),
					Value: pulumi.String("yes"),
				},
			},
			Name:   pulumi.String("my-parameter-group"),
			Family: pulumi.String("memorydb_redis6"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_memorydb_parametergroup" "example" {
  parameters {
    name  = "activedefrag"
    value = "yes"
  }
  name   = "my-parameter-group"
  family = "memorydb_redis6"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.memorydb.ParameterGroup;
import com.pulumi.aws.memorydb.ParameterGroupArgs;
import com.pulumi.aws.memorydb.inputs.ParameterGroupParameterArgs;
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 ParameterGroup("example", ParameterGroupArgs.builder()
            .parameters(ParameterGroupParameterArgs.builder()
                .name("activedefrag")
                .value("yes")
                .build())
            .name("my-parameter-group")
            .family("memorydb_redis6")
            .build());

    }
}
resources:
  example:
    type: aws:memorydb:ParameterGroup
    properties:
      parameters:
        - name: activedefrag
          value: yes
      name: my-parameter-group
      family: memorydb_redis6

Import

Using pulumi import, import a parameter group using the name. For example:

$ pulumi import aws:memorydb/parameterGroup:ParameterGroup example my-parameter-group

Constructors

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

Properties

arn ↔ Output<String>
The ARN of the parameter group.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
description ↔ Output<String?>
Description for the parameter group. Defaults to "Managed by Pulumi".
latefinal
family ↔ Output<String>
The engine version that the parameter group can be used with.
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>
Name of the parameter group. If omitted, the provider will assign a random, unique name. Conflicts with namePrefix.
latefinal
namePrefix ↔ Output<String>
Creates a unique name beginning with the specified prefix. Conflicts with name.
latefinal
parameters ↔ Output<List<ParameterGroupParameter>?>
Set of MemoryDB parameters to apply. Any parameters not specified will fall back to their family defaults. Detailed below.
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, {ParameterGroupState? state, CustomResourceOptions? options}) → ParameterGroup
Gets an existing ParameterGroup resource's state with the given name and id.