ParameterGroup

Provides an ElastiCache parameter group resource.

NOTE: Attempting to remove the reserved-memory parameter when family is set to redis2.6 or redis2.8 may show a perpetual difference in this provider due to an Elasticache API limitation. Leave that parameter configured with any value to workaround the issue.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var @default = new Aws.ElastiCache.ParameterGroup("default", new Aws.ElastiCache.ParameterGroupArgs
        {
            Family = "redis2.8",
            Parameters = 
            {
                new Aws.ElastiCache.Inputs.ParameterGroupParameterArgs
                {
                    Name = "activerehashing",
                    Value = "yes",
                },
                new Aws.ElastiCache.Inputs.ParameterGroupParameterArgs
                {
                    Name = "min-slaves-to-write",
                    Value = "2",
                },
            },
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := elasticache.NewParameterGroup(ctx, "_default", &elasticache.ParameterGroupArgs{
            Family: pulumi.String("redis2.8"),
            Parameters: elasticache.ParameterGroupParameterArray{
                &elasticache.ParameterGroupParameterArgs{
                    Name:  pulumi.String("activerehashing"),
                    Value: pulumi.String("yes"),
                },
                &elasticache.ParameterGroupParameterArgs{
                    Name:  pulumi.String("min-slaves-to-write"),
                    Value: pulumi.String("2"),
                },
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

default = aws.elasticache.ParameterGroup("default",
    family="redis2.8",
    parameters=[
        {
            "name": "activerehashing",
            "value": "yes",
        },
        {
            "name": "min-slaves-to-write",
            "value": "2",
        },
    ])

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

const defaultParameterGroup = new aws.elasticache.ParameterGroup("default", {
    family: "redis2.8",
    parameters: [
        {
            name: "activerehashing",
            value: "yes",
        },
        {
            name: "min-slaves-to-write",
            value: "2",
        },
    ],
});

Create a ParameterGroup Resource

new ParameterGroup(name: string, args: ParameterGroupArgs, opts?: CustomResourceOptions);

def ParameterGroup(resource_name, opts=None, description=None, family=None, name=None, parameters=None, __props__=None);

func NewParameterGroup(ctx *Context, name string, args ParameterGroupArgs, opts ...ResourceOption) (*ParameterGroup, error)

public ParameterGroup(string name, ParameterGroupArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ParameterGroupArgs: 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 ParameterGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ParameterGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ParameterGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The ParameterGroup resource accepts the following input properties:

Family string: The family of the ElastiCache parameter group.
Description string: The description of the ElastiCache parameter group. Defaults to “Managed by Pulumi”.
Name string: The name of the ElastiCache parameter.
Parameters List<ParameterGroupParameterArgs>: A list of ElastiCache parameters to apply.

Family string: The family of the ElastiCache parameter group.
Description string: The description of the ElastiCache parameter group. Defaults to “Managed by Pulumi”.
Name string: The name of the ElastiCache parameter.
Parameters []ParameterGroupParameter: A list of ElastiCache parameters to apply.

family string: The family of the ElastiCache parameter group.
description string: The description of the ElastiCache parameter group. Defaults to “Managed by Pulumi”.
name string: The name of the ElastiCache parameter.
parameters ParameterGroupParameter[]: A list of ElastiCache parameters to apply.

family str: The family of the ElastiCache parameter group.
description str: The description of the ElastiCache parameter group. Defaults to “Managed by Pulumi”.
name str: The name of the ElastiCache parameter.
parameters List[ParameterGroupParameter]: A list of ElastiCache parameters to apply.

Outputs

All input properties are implicitly available as output properties. Additionally, the ParameterGroup resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing ParameterGroup Resource

Get an existing ParameterGroup 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?: ParameterGroupState, opts?: CustomResourceOptions): ParameterGroup

static get(resource_name, id, opts=None, description=None, family=None, name=None, parameters=None, __props__=None);

func GetParameterGroup(ctx *Context, name string, id IDInput, state *ParameterGroupState, opts ...ResourceOption) (*ParameterGroup, error)

public static ParameterGroup Get(string name, Input<string> id, ParameterGroupState? 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:

Description string: The description of the ElastiCache parameter group. Defaults to “Managed by Pulumi”.
Family string: The family of the ElastiCache parameter group.
Name string: The name of the ElastiCache parameter.
Parameters List<ParameterGroupParameterArgs>: A list of ElastiCache parameters to apply.

Description string: The description of the ElastiCache parameter group. Defaults to “Managed by Pulumi”.
Family string: The family of the ElastiCache parameter group.
Name string: The name of the ElastiCache parameter.
Parameters []ParameterGroupParameter: A list of ElastiCache parameters to apply.

description string: The description of the ElastiCache parameter group. Defaults to “Managed by Pulumi”.
family string: The family of the ElastiCache parameter group.
name string: The name of the ElastiCache parameter.
parameters ParameterGroupParameter[]: A list of ElastiCache parameters to apply.

description str: The description of the ElastiCache parameter group. Defaults to “Managed by Pulumi”.
family str: The family of the ElastiCache parameter group.
name str: The name of the ElastiCache parameter.
parameters List[ParameterGroupParameter]: A list of ElastiCache parameters to apply.

Supporting Types

ParameterGroupParameter

See the input and output API doc for this type.

Name string: The name of the ElastiCache parameter.
Value string: The value of the ElastiCache parameter.

Name string: The name of the ElastiCache parameter.
Value string: The value of the ElastiCache parameter.

name string: The name of the ElastiCache parameter.
value string: The value of the ElastiCache parameter.

name str: The name of the ElastiCache parameter.
value str: The value of the ElastiCache parameter.

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