Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. dax
  5. ParameterGroup

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-aws

aws.dax.ParameterGroup

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a DAX Parameter Group resource.

    Example Usage

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

const example = new aws.dax.ParameterGroup("example", {
    name: "example",
    parameters: [
        {
            name: "query-ttl-millis",
            value: "100000",
        },
        {
            name: "record-ttl-millis",
            value: "100000",
        },
    ],
});

    import pulumi
import pulumi_aws as aws

example = aws.dax.ParameterGroup("example",
    name="example",
    parameters=[
        aws.dax.ParameterGroupParameterArgs(
            name="query-ttl-millis",
            value="100000",
        ),
        aws.dax.ParameterGroupParameterArgs(
            name="record-ttl-millis",
            value="100000",
        ),
    ])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dax.NewParameterGroup(ctx, "example", &dax.ParameterGroupArgs{
			Name: pulumi.String("example"),
			Parameters: dax.ParameterGroupParameterArray{
				&dax.ParameterGroupParameterArgs{
					Name:  pulumi.String("query-ttl-millis"),
					Value: pulumi.String("100000"),
				},
				&dax.ParameterGroupParameterArgs{
					Name:  pulumi.String("record-ttl-millis"),
					Value: pulumi.String("100000"),
				},
			},
		})
		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.Dax.ParameterGroup("example", new()
    {
        Name = "example",
        Parameters = new[]
        {
            new Aws.Dax.Inputs.ParameterGroupParameterArgs
            {
                Name = "query-ttl-millis",
                Value = "100000",
            },
            new Aws.Dax.Inputs.ParameterGroupParameterArgs
            {
                Name = "record-ttl-millis",
                Value = "100000",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dax.ParameterGroup;
import com.pulumi.aws.dax.ParameterGroupArgs;
import com.pulumi.aws.dax.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("example")
            .parameters(            
                ParameterGroupParameterArgs.builder()
                    .name("query-ttl-millis")
                    .value("100000")
                    .build(),
                ParameterGroupParameterArgs.builder()
                    .name("record-ttl-millis")
                    .value("100000")
                    .build())
            .build());

    }
}

    resources:
  example:
    type: aws:dax:ParameterGroup
    properties:
      name: example
      parameters:
        - name: query-ttl-millis
          value: '100000'
        - name: record-ttl-millis
          value: '100000'

    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: Optional[ParameterGroupArgs] = None,
                   opts: Optional[ResourceOptions] = None)

@overload
def ParameterGroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   description: Optional[str] = None,
                   name: Optional[str] = None,
                   parameters: Optional[Sequence[ParameterGroupParameterArgs]] = None)
    func NewParameterGroup(ctx *Context, name string, args *ParameterGroupArgs, opts ...ResourceOption) (*ParameterGroup, error)
    public ParameterGroup(string name, ParameterGroupArgs? args = null, CustomResourceOptions? opts = null)
    public ParameterGroup(String name, ParameterGroupArgs args)
public ParameterGroup(String name, ParameterGroupArgs args, CustomResourceOptions options)

    type: aws:dax: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.

    Example

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

    var parameterGroupResource = new Aws.Dax.ParameterGroup("parameterGroupResource", new()
{
    Description = "string",
    Name = "string",
    Parameters = new[]
    {
        new Aws.Dax.Inputs.ParameterGroupParameterArgs
        {
            Name = "string",
            Value = "string",
        },
    },
});

    example, err := dax.NewParameterGroup(ctx, "parameterGroupResource", &dax.ParameterGroupArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Parameters: dax.ParameterGroupParameterArray{
		&dax.ParameterGroupParameterArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
})

    var parameterGroupResource = new ParameterGroup("parameterGroupResource", ParameterGroupArgs.builder()        
    .description("string")
    .name("string")
    .parameters(ParameterGroupParameterArgs.builder()
        .name("string")
        .value("string")
        .build())
    .build());

    parameter_group_resource = aws.dax.ParameterGroup("parameterGroupResource",
    description="string",
    name="string",
    parameters=[aws.dax.ParameterGroupParameterArgs(
        name="string",
        value="string",
    )])

    const parameterGroupResource = new aws.dax.ParameterGroup("parameterGroupResource", {
    description: "string",
    name: "string",
    parameters: [{
        name: "string",
        value: "string",
    }],
});

    type: aws:dax:ParameterGroup
properties:
    description: string
    name: string
    parameters:
        - name: string
          value: 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

    The ParameterGroup resource accepts the following input properties:

    Description string
    A description of the parameter group.
    Name string
    The name of the parameter group.
    Parameters List<ParameterGroupParameter>
    The parameters of the parameter group.
    Description string
    A description of the parameter group.
    Name string
    The name of the parameter group.
    Parameters []ParameterGroupParameterArgs
    The parameters of the parameter group.
    description String
    A description of the parameter group.
    name String
    The name of the parameter group.
    parameters List<ParameterGroupParameter>
    The parameters of the parameter group.
    description string
    A description of the parameter group.
    name string
    The name of the parameter group.
    parameters ParameterGroupParameter[]
    The parameters of the parameter group.
    description str
    A description of the parameter group.
    name str
    The name of the parameter group.
    parameters Sequence[ParameterGroupParameterArgs]
    The parameters of the parameter group.
    description String
    A description of the parameter group.
    name String
    The name of the parameter group.
    parameters List<Property Map>
    The parameters of the parameter group.

    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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    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,
        description: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[Sequence[ParameterGroupParameterArgs]] = 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:
    Description string
    A description of the parameter group.
    Name string
    The name of the parameter group.
    Parameters List<ParameterGroupParameter>
    The parameters of the parameter group.
    Description string
    A description of the parameter group.
    Name string
    The name of the parameter group.
    Parameters []ParameterGroupParameterArgs
    The parameters of the parameter group.
    description String
    A description of the parameter group.
    name String
    The name of the parameter group.
    parameters List<ParameterGroupParameter>
    The parameters of the parameter group.
    description string
    A description of the parameter group.
    name string
    The name of the parameter group.
    parameters ParameterGroupParameter[]
    The parameters of the parameter group.
    description str
    A description of the parameter group.
    name str
    The name of the parameter group.
    parameters Sequence[ParameterGroupParameterArgs]
    The parameters of the parameter group.
    description String
    A description of the parameter group.
    name String
    The name of the parameter group.
    parameters List<Property Map>
    The parameters of the parameter group.

    Supporting Types

    ParameterGroupParameter, ParameterGroupParameterArgs

    Name string
    The name of the parameter.
    Value string
    The value for the parameter.
    Name string
    The name of the parameter.
    Value string
    The value for the parameter.
    name String
    The name of the parameter.
    value String
    The value for the parameter.
    name string
    The name of the parameter.
    value string
    The value for the parameter.
    name str
    The name of the parameter.
    value str
    The value for the parameter.
    name String
    The name of the parameter.
    value String
    The value for the parameter.

    Import

    Using pulumi import, import DAX Parameter Group using the name. For example:

    $ pulumi import aws:dax/parameterGroup:ParameterGroup example my_dax_pg

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi
    pulumi/pulumi-aws