AWS v6.77.0, Apr 9 25

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

aws.elasticache.ParameterGroup

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

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

import pulumi
import pulumi_aws as aws

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

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := elasticache.NewParameterGroup(ctx, "default", &elasticache.ParameterGroupArgs{
			Name:   pulumi.String("cache-params"),
			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
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var @default = new Aws.ElastiCache.ParameterGroup("default", new()
    {
        Name = "cache-params",
        Family = "redis2.8",
        Parameters = new[]
        {
            new Aws.ElastiCache.Inputs.ParameterGroupParameterArgs
            {
                Name = "activerehashing",
                Value = "yes",
            },
            new Aws.ElastiCache.Inputs.ParameterGroupParameterArgs
            {
                Name = "min-slaves-to-write",
                Value = "2",
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.elasticache.ParameterGroup;
import com.pulumi.aws.elasticache.ParameterGroupArgs;
import com.pulumi.aws.elasticache.inputs.ParameterGroupParameterArgs;
import java.util.List;
import java.util.ArrayList;
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 ParameterGroup("default", ParameterGroupArgs.builder()
            .name("cache-params")
            .family("redis2.8")
            .parameters(            
                ParameterGroupParameterArgs.builder()
                    .name("activerehashing")
                    .value("yes")
                    .build(),
                ParameterGroupParameterArgs.builder()
                    .name("min-slaves-to-write")
                    .value("2")
                    .build())
            .build());

    }
}

resources:
  default:
    type: aws:elasticache:ParameterGroup
    properties:
      name: cache-params
      family: redis2.8
      parameters:
        - name: activerehashing
          value: yes
        - name: min-slaves-to-write
          value: '2'

Create ParameterGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

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

@overload
def ParameterGroup(resource_name: str,
                   args: ParameterGroupArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ParameterGroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   family: Optional[str] = None,
                   description: Optional[str] = None,
                   name: Optional[str] = None,
                   parameters: Optional[Sequence[ParameterGroupParameterArgs]] = None,
                   tags: Optional[Mapping[str, str]] = None)

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

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

public ParameterGroup(String name, ParameterGroupArgs args)
public ParameterGroup(String name, ParameterGroupArgs args, CustomResourceOptions options)

type: aws:elasticache:ParameterGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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.
args ParameterGroupArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control 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.

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

Constructor example

The following reference example uses placeholder values for all input properties.

TypeScript
Python
Go
C#
Java
YAML

var awsParameterGroupResource = new Aws.ElastiCache.ParameterGroup("awsParameterGroupResource", new()
{
    Family = "string",
    Description = "string",
    Name = "string",
    Parameters = new[]
    {
        new Aws.ElastiCache.Inputs.ParameterGroupParameterArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
});

example, err := elasticache.NewParameterGroup(ctx, "awsParameterGroupResource", &elasticache.ParameterGroupArgs{
	Family:      pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Parameters: elasticache.ParameterGroupParameterArray{
		&elasticache.ParameterGroupParameterArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

var awsParameterGroupResource = new ParameterGroup("awsParameterGroupResource", ParameterGroupArgs.builder()
    .family("string")
    .description("string")
    .name("string")
    .parameters(ParameterGroupParameterArgs.builder()
        .name("string")
        .value("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

aws_parameter_group_resource = aws.elasticache.ParameterGroup("awsParameterGroupResource",
    family="string",
    description="string",
    name="string",
    parameters=[{
        "name": "string",
        "value": "string",
    }],
    tags={
        "string": "string",
    })

const awsParameterGroupResource = new aws.elasticache.ParameterGroup("awsParameterGroupResource", {
    family: "string",
    description: "string",
    name: "string",
    parameters: [{
        name: "string",
        value: "string",
    }],
    tags: {
        string: "string",
    },
});

type: aws:elasticache:ParameterGroup
properties:
    description: string
    family: string
    name: string
    parameters:
        - name: string
          value: string
    tags:
        string: string

ParameterGroup Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

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<ParameterGroupParameter>: A list of ElastiCache parameters to apply.
Tags Dictionary<string, string>: Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

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 []ParameterGroupParameterArgs: A list of ElastiCache parameters to apply.
Tags map[string]string: Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

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<ParameterGroupParameter>: A list of ElastiCache parameters to apply.
tags Map<String,String>: Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

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.
tags {[key: string]: string}: Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

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 Sequence[ParameterGroupParameterArgs]: A list of ElastiCache parameters to apply.
tags Mapping[str, str]: Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

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<Property Map>: A list of ElastiCache parameters to apply.
tags Map<String>: Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

Outputs

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

Arn string: The AWS ARN associated with the parameter group.
Id string: The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

Arn string: The AWS ARN associated with the parameter group.
Id string: The provider-assigned unique ID for this managed resource.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

arn String: The AWS ARN associated with the parameter group.
id String: The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

arn string: The AWS ARN associated with the parameter group.
id string: The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

arn str: The AWS ARN associated with the parameter group.
id str: The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

arn String: The AWS ARN associated with the parameter group.
id String: The provider-assigned unique ID for this managed resource.
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

Look up Existing ParameterGroup Resource

Get an existing ParameterGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: ParameterGroupState, opts?: CustomResourceOptions): ParameterGroup

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        family: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[Sequence[ParameterGroupParameterArgs]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ParameterGroup

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)

public static ParameterGroup get(String name, Output<String> id, ParameterGroupState state, CustomResourceOptions options)

resources:  _:    type: aws:elasticache:ParameterGroup    get:      id: ${id}

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.

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 AWS ARN associated with the parameter group.
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<ParameterGroupParameter>: A list of ElastiCache parameters to apply.
Tags Dictionary<string, string>: Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

Arn string: The AWS ARN associated with the parameter group.
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 []ParameterGroupParameterArgs: A list of ElastiCache parameters to apply.
Tags map[string]string: Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

arn String: The AWS ARN associated with the parameter group.
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<ParameterGroupParameter>: A list of ElastiCache parameters to apply.
tags Map<String,String>: Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

arn string: The AWS ARN associated with the parameter group.
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.
tags {[key: string]: string}: Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

arn str: The AWS ARN associated with the parameter group.
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 Sequence[ParameterGroupParameterArgs]: A list of ElastiCache parameters to apply.
tags Mapping[str, str]: Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

arn String: The AWS ARN associated with the parameter group.
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<Property Map>: A list of ElastiCache parameters to apply.
tags Map<String>: Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
Deprecated: Please use tags instead.

Supporting Types

ParameterGroupParameter
, ParameterGroupParameterArgs

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 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.

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

Import

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

$ pulumi import aws:elasticache/parameterGroup:ParameterGroup default redis-params

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

pulumi/pulumi-aws

aws.elasticache.ParameterGroup

On this page

On this page

Example Usage

Create ParameterGroup Resource

Constructor syntax

Parameters

Constructor example

ParameterGroup Resource Properties

Inputs

Outputs

Look up Existing ParameterGroup Resource

Supporting Types

ParameterGroupParameter
, ParameterGroupParameterArgs

Import

Package Details

On this page

On this page

aws.elasticache.ParameterGroup

On this page

On this page

Example Usage

Create ParameterGroup Resource

Constructor syntax

Parameters

Constructor example

ParameterGroup Resource Properties

Inputs

Outputs

Look up Existing ParameterGroup Resource

Supporting Types

ParameterGroupParameter, ParameterGroupParameterArgs

Import

Package Details

On this page

On this page

ParameterGroupParameter
, ParameterGroupParameterArgs