aws.elasticache.ParameterGroup
Provides an ElastiCache parameter group resource.
NOTE: Attempting to remove the
reserved-memory
parameter whenfamily
is set toredis2.6
orredis2.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 System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var @default = new Aws.ElastiCache.ParameterGroup("default", new()
{
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/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{
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
})
}
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()
.family("redis2.8")
.parameters(
ParameterGroupParameterArgs.builder()
.name("activerehashing")
.value("yes")
.build(),
ParameterGroupParameterArgs.builder()
.name("min-slaves-to-write")
.value("2")
.build())
.build());
}
}
import pulumi
import pulumi_aws as aws
default = aws.elasticache.ParameterGroup("default",
family="redis2.8",
parameters=[
aws.elasticache.ParameterGroupParameterArgs(
name="activerehashing",
value="yes",
),
aws.elasticache.ParameterGroupParameterArgs(
name="min-slaves-to-write",
value="2",
),
])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const _default = new aws.elasticache.ParameterGroup("default", {
family: "redis2.8",
parameters: [
{
name: "activerehashing",
value: "yes",
},
{
name: "min-slaves-to-write",
value: "2",
},
],
});
resources:
default:
type: aws:elasticache:ParameterGroup
properties:
family: redis2.8
parameters:
- name: activerehashing
value: yes
- name: min-slaves-to-write
value: '2'
Create ParameterGroup Resource
new ParameterGroup(name: string, args: ParameterGroupArgs, opts?: CustomResourceOptions);
@overload
def ParameterGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
family: Optional[str] = None,
name: Optional[str] = None,
parameters: Optional[Sequence[ParameterGroupParameterArgs]] = None,
tags: Optional[Mapping[str, str]] = None)
@overload
def ParameterGroup(resource_name: str,
args: ParameterGroupArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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
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<Parameter
Group Parameter Args> A list of ElastiCache parameters to apply.
- 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
[]Parameter
Group Parameter Args A list of ElastiCache parameters to apply.
- 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<Parameter
Group Parameter Args> A list of ElastiCache parameters to apply.
- 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
Parameter
Group Parameter Args[] A list of ElastiCache parameters to apply.
- {[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[Parameter
Group Parameter Args] A list of ElastiCache parameters to apply.
- 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.
- 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:
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.
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)
Resource lookup is not supported in YAML
- 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.
- 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<Parameter
Group Parameter Args> A list of ElastiCache parameters to apply.
- 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- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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
[]Parameter
Group Parameter Args A list of ElastiCache parameters to apply.
- 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- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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<Parameter
Group Parameter Args> A list of ElastiCache parameters to apply.
- 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- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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
Parameter
Group Parameter Args[] A list of ElastiCache parameters to apply.
- {[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- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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[Parameter
Group Parameter Args] A list of ElastiCache parameters to apply.
- 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- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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.
- 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- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Supporting Types
ParameterGroupParameter
Import
ElastiCache Parameter Groups can be imported using the name
, e.g.,
$ pulumi import aws:elasticache/parameterGroup:ParameterGroup default redis-params
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.