Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. memorydb
  5. ParameterGroup
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.memorydb.ParameterGroup

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    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", {
    name: "my-parameter-group",
    family: "memorydb_redis6",
    parameters: [{
        name: "activedefrag",
        value: "yes",
    }],
});

    import pulumi
import pulumi_aws as aws

example = aws.memorydb.ParameterGroup("example",
    name="my-parameter-group",
    family="memorydb_redis6",
    parameters=[{
        "name": "activedefrag",
        "value": "yes",
    }])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			Name:   pulumi.String("my-parameter-group"),
			Family: pulumi.String("memorydb_redis6"),
			Parameters: memorydb.ParameterGroupParameterArray{
				&memorydb.ParameterGroupParameterArgs{
					Name:  pulumi.String("activedefrag"),
					Value: pulumi.String("yes"),
				},
			},
		})
		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 example = new Aws.MemoryDb.ParameterGroup("example", new()
    {
        Name = "my-parameter-group",
        Family = "memorydb_redis6",
        Parameters = new[]
        {
            new Aws.MemoryDb.Inputs.ParameterGroupParameterArgs
            {
                Name = "activedefrag",
                Value = "yes",
            },
        },
    });

});

    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.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 example = new ParameterGroup("example", ParameterGroupArgs.builder()
            .name("my-parameter-group")
            .family("memorydb_redis6")
            .parameters(ParameterGroupParameterArgs.builder()
                .name("activedefrag")
                .value("yes")
                .build())
            .build());

    }
}

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

    Create ParameterGroup Resource

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

    Constructor syntax

    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,
                   name_prefix: 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:memorydb: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.

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

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

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

    exampleparameter_group_resource_resource_from_memorydbparameter_group = aws.memorydb.ParameterGroup("exampleparameterGroupResourceResourceFromMemorydbparameterGroup",
    family="string",
    description="string",
    name="string",
    name_prefix="string",
    parameters=[{
        "name": "string",
        "value": "string",
    }],
    tags={
        "string": "string",
    })

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

    type: aws:memorydb:ParameterGroup
properties:
    description: string
    family: string
    name: string
    namePrefix: 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 engine version that the parameter group can be used with.

    The following arguments are optional:

    Description string
    Description for the parameter group.
    Name string
    Name of the parameter group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Parameters List<ParameterGroupParameter>
    Set of MemoryDB parameters to apply. Any parameters not specified will fall back to their family defaults. Detailed below.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. 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 engine version that the parameter group can be used with.

    The following arguments are optional:

    Description string
    Description for the parameter group.
    Name string
    Name of the parameter group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Parameters []ParameterGroupParameterArgs
    Set of MemoryDB parameters to apply. Any parameters not specified will fall back to their family defaults. Detailed below.
    Tags map[string]string
    A map of tags to assign to the resource. 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 engine version that the parameter group can be used with.

    The following arguments are optional:

    description String
    Description for the parameter group.
    name String
    Name of the parameter group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters List<ParameterGroupParameter>
    Set of MemoryDB parameters to apply. Any parameters not specified will fall back to their family defaults. Detailed below.
    tags Map<String,String>
    A map of tags to assign to the resource. 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 engine version that the parameter group can be used with.

    The following arguments are optional:

    description string
    Description for the parameter group.
    name string
    Name of the parameter group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters ParameterGroupParameter[]
    Set of MemoryDB parameters to apply. Any parameters not specified will fall back to their family defaults. Detailed below.
    tags {[key: string]: string}
    A map of tags to assign to the resource. 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 engine version that the parameter group can be used with.

    The following arguments are optional:

    description str
    Description for the parameter group.
    name str
    Name of the parameter group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    name_prefix str
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters Sequence[ParameterGroupParameterArgs]
    Set of MemoryDB parameters to apply. Any parameters not specified will fall back to their family defaults. Detailed below.
    tags Mapping[str, str]
    A map of tags to assign to the resource. 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 engine version that the parameter group can be used with.

    The following arguments are optional:

    description String
    Description for the parameter group.
    name String
    Name of the parameter group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters List<Property Map>
    Set of MemoryDB parameters to apply. Any parameters not specified will fall back to their family defaults. Detailed below.
    tags Map<String>
    A map of tags to assign to the resource. 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 ARN of 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 ARN of 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 ARN of 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 ARN of 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 ARN of 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 ARN of 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.

    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,
        name_prefix: 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.
    The following state arguments are supported:
    Arn string
    The ARN of the parameter group.
    Description string
    Description for the parameter group.
    Family string

    The engine version that the parameter group can be used with.

    The following arguments are optional:

    Name string
    Name of the parameter group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Parameters List<ParameterGroupParameter>
    Set of MemoryDB parameters to apply. Any parameters not specified will fall back to their family defaults. Detailed below.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. 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 ARN of the parameter group.
    Description string
    Description for the parameter group.
    Family string

    The engine version that the parameter group can be used with.

    The following arguments are optional:

    Name string
    Name of the parameter group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Parameters []ParameterGroupParameterArgs
    Set of MemoryDB parameters to apply. Any parameters not specified will fall back to their family defaults. Detailed below.
    Tags map[string]string
    A map of tags to assign to the resource. 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 ARN of the parameter group.
    description String
    Description for the parameter group.
    family String

    The engine version that the parameter group can be used with.

    The following arguments are optional:

    name String
    Name of the parameter group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters List<ParameterGroupParameter>
    Set of MemoryDB parameters to apply. Any parameters not specified will fall back to their family defaults. Detailed below.
    tags Map<String,String>
    A map of tags to assign to the resource. 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 ARN of the parameter group.
    description string
    Description for the parameter group.
    family string

    The engine version that the parameter group can be used with.

    The following arguments are optional:

    name string
    Name of the parameter group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters ParameterGroupParameter[]
    Set of MemoryDB parameters to apply. Any parameters not specified will fall back to their family defaults. Detailed below.
    tags {[key: string]: string}
    A map of tags to assign to the resource. 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 ARN of the parameter group.
    description str
    Description for the parameter group.
    family str

    The engine version that the parameter group can be used with.

    The following arguments are optional:

    name str
    Name of the parameter group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    name_prefix str
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters Sequence[ParameterGroupParameterArgs]
    Set of MemoryDB parameters to apply. Any parameters not specified will fall back to their family defaults. Detailed below.
    tags Mapping[str, str]
    A map of tags to assign to the resource. 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 ARN of the parameter group.
    description String
    Description for the parameter group.
    family String

    The engine version that the parameter group can be used with.

    The following arguments are optional:

    name String
    Name of the parameter group. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters List<Property Map>
    Set of MemoryDB parameters to apply. Any parameters not specified will fall back to their family defaults. Detailed below.
    tags Map<String>
    A map of tags to assign to the resource. 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 parameter.
    Value string
    The value of the parameter.
    Name string
    The name of the parameter.
    Value string
    The value of the parameter.
    name String
    The name of the parameter.
    value String
    The value of the parameter.
    name string
    The name of the parameter.
    value string
    The value of the parameter.
    name str
    The name of the parameter.
    value str
    The value of the parameter.
    name String
    The name of the parameter.
    value String
    The value of the parameter.

    Import

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

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

    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 logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws