ParameterGroup class
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
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const _default = new aws.elasticache.ParameterGroup("default", {
parameters: [
{
name: "activerehashing",
value: "yes",
},
{
name: "min-slaves-to-write",
value: "2",
},
],
name: "cache-params",
family: "redis2.8",
});
import pulumi
import pulumi_aws as aws
default = aws.elasticache.ParameterGroup("default",
parameters=[
{
"name": "activerehashing",
"value": "yes",
},
{
"name": "min-slaves-to-write",
"value": "2",
},
],
name="cache-params",
family="redis2.8")
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()
{
Parameters = new[]
{
new Aws.ElastiCache.Inputs.ParameterGroupParameterArgs
{
Name = "activerehashing",
Value = "yes",
},
new Aws.ElastiCache.Inputs.ParameterGroupParameterArgs
{
Name = "min-slaves-to-write",
Value = "2",
},
},
Name = "cache-params",
Family = "redis2.8",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
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"),
},
},
Name: pulumi.String("cache-params"),
Family: pulumi.String("redis2.8"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_elasticache_parametergroup" "default" {
parameters {
name = "activerehashing"
value = "yes"
}
parameters {
name = "min-slaves-to-write"
value = "2"
}
name = "cache-params"
family = "redis2.8"
}
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.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 ParameterGroup("default", ParameterGroupArgs.builder()
.parameters(
ParameterGroupParameterArgs.builder()
.name("activerehashing")
.value("yes")
.build(),
ParameterGroupParameterArgs.builder()
.name("min-slaves-to-write")
.value("2")
.build())
.name("cache-params")
.family("redis2.8")
.build());
}
}
resources:
default:
type: aws:elasticache:ParameterGroup
properties:
parameters:
- name: activerehashing
value: yes
- name: min-slaves-to-write
value: '2'
name: cache-params
family: redis2.8
Import
Using pulumi import, import ElastiCache Parameter Groups using the name. For example:
$ pulumi import aws:elasticache/parameterGroup:ParameterGroup default redis-params
Constructors
- ParameterGroup(String name, {ParameterGroupArgs? args, CustomResourceOptions? options})
-
Creates a new ParameterGroup.
nameThe Pulumi resource name.argsArguments used to configure this ParameterGroup. The set of arguments for ParameterGroup.optionsResource options controlling this resource's behavior. - ParameterGroup.reference(String urn)
- Creates a typed reference to an existing ParameterGroup resource.
Properties
-
arn
↔ Output<
String> -
The AWS ARN associated with the parameter group.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String> -
The description of the ElastiCache parameter group. Defaults to "Managed by Pulumi".
latefinal
-
family
↔ Output<
String> -
The family of the ElastiCache 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 ElastiCache parameter.
latefinal
-
parameters
↔ Output<
List< ParameterGroupParameter> ?> -
A list of ElastiCache parameters to apply.
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
-
Key-value mapping of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-levellatefinal -
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, {ParameterGroupState? state, CustomResourceOptions? options}) → ParameterGroup -
Gets an existing ParameterGroup resource's state with the given
nameandid.