AWS v6.75.0, Apr 2 25

AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi

aws.redshift.ParameterGroup

Explore with Pulumi AI

AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const bar = new aws.redshift.ParameterGroup("bar", {
    name: "parameter-group-test",
    family: "redshift-1.0",
    parameters: [
        {
            name: "require_ssl",
            value: "true",
        },
        {
            name: "query_group",
            value: "example",
        },
        {
            name: "enable_user_activity_logging",
            value: "true",
        },
    ],
});

import pulumi
import pulumi_aws as aws

bar = aws.redshift.ParameterGroup("bar",
    name="parameter-group-test",
    family="redshift-1.0",
    parameters=[
        {
            "name": "require_ssl",
            "value": "true",
        },
        {
            "name": "query_group",
            "value": "example",
        },
        {
            "name": "enable_user_activity_logging",
            "value": "true",
        },
    ])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redshift.NewParameterGroup(ctx, "bar", &redshift.ParameterGroupArgs{
			Name:   pulumi.String("parameter-group-test"),
			Family: pulumi.String("redshift-1.0"),
			Parameters: redshift.ParameterGroupParameterArray{
				&redshift.ParameterGroupParameterArgs{
					Name:  pulumi.String("require_ssl"),
					Value: pulumi.String("true"),
				},
				&redshift.ParameterGroupParameterArgs{
					Name:  pulumi.String("query_group"),
					Value: pulumi.String("example"),
				},
				&redshift.ParameterGroupParameterArgs{
					Name:  pulumi.String("enable_user_activity_logging"),
					Value: pulumi.String("true"),
				},
			},
		})
		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 bar = new Aws.RedShift.ParameterGroup("bar", new()
    {
        Name = "parameter-group-test",
        Family = "redshift-1.0",
        Parameters = new[]
        {
            new Aws.RedShift.Inputs.ParameterGroupParameterArgs
            {
                Name = "require_ssl",
                Value = "true",
            },
            new Aws.RedShift.Inputs.ParameterGroupParameterArgs
            {
                Name = "query_group",
                Value = "example",
            },
            new Aws.RedShift.Inputs.ParameterGroupParameterArgs
            {
                Name = "enable_user_activity_logging",
                Value = "true",
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.ParameterGroup;
import com.pulumi.aws.redshift.ParameterGroupArgs;
import com.pulumi.aws.redshift.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 bar = new ParameterGroup("bar", ParameterGroupArgs.builder()
            .name("parameter-group-test")
            .family("redshift-1.0")
            .parameters(            
                ParameterGroupParameterArgs.builder()
                    .name("require_ssl")
                    .value("true")
                    .build(),
                ParameterGroupParameterArgs.builder()
                    .name("query_group")
                    .value("example")
                    .build(),
                ParameterGroupParameterArgs.builder()
                    .name("enable_user_activity_logging")
                    .value("true")
                    .build())
            .build());

    }
}

resources:
  bar:
    type: aws:redshift:ParameterGroup
    properties:
      name: parameter-group-test
      family: redshift-1.0
      parameters:
        - name: require_ssl
          value: 'true'
        - name: query_group
          value: example
        - name: enable_user_activity_logging
          value: 'true'

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:redshift: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 exampleparameterGroupResourceResourceFromRedshiftparameterGroup = new Aws.RedShift.ParameterGroup("exampleparameterGroupResourceResourceFromRedshiftparameterGroup", new()
{
    Family = "string",
    Description = "string",
    Name = "string",
    Parameters = new[]
    {
        new Aws.RedShift.Inputs.ParameterGroupParameterArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
});

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

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

exampleparameter_group_resource_resource_from_redshiftparameter_group = aws.redshift.ParameterGroup("exampleparameterGroupResourceResourceFromRedshiftparameterGroup",
    family="string",
    description="string",
    name="string",
    parameters=[{
        "name": "string",
        "value": "string",
    }],
    tags={
        "string": "string",
    })

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

type: aws:redshift: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 Redshift parameter group.

Description string

The description of the Redshift parameter group. Defaults to "Managed by Pulumi".

Name string

The name of the Redshift parameter.

Parameters List<ParameterGroupParameter>

A list of Redshift parameters to apply.

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.

You can read more about the parameters that Redshift supports in the documentation

Family string

The family of the Redshift parameter group.

Description string

The description of the Redshift parameter group. Defaults to "Managed by Pulumi".

Name string

The name of the Redshift parameter.

Parameters []ParameterGroupParameterArgs

A list of Redshift parameters to apply.

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.

You can read more about the parameters that Redshift supports in the documentation

family String

The family of the Redshift parameter group.

description String

The description of the Redshift parameter group. Defaults to "Managed by Pulumi".

name String

The name of the Redshift parameter.

parameters List<ParameterGroupParameter>

A list of Redshift parameters to apply.

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.

You can read more about the parameters that Redshift supports in the documentation

family string

The family of the Redshift parameter group.

description string

The description of the Redshift parameter group. Defaults to "Managed by Pulumi".

name string

The name of the Redshift parameter.

parameters ParameterGroupParameter[]

A list of Redshift parameters to apply.

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.

You can read more about the parameters that Redshift supports in the documentation

family str

The family of the Redshift parameter group.

description str

The description of the Redshift parameter group. Defaults to "Managed by Pulumi".

name str

The name of the Redshift parameter.

parameters Sequence[ParameterGroupParameterArgs]

A list of Redshift parameters to apply.

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.

You can read more about the parameters that Redshift supports in the documentation

family String

The family of the Redshift parameter group.

description String

The description of the Redshift parameter group. Defaults to "Managed by Pulumi".

name String

The name of the Redshift parameter.

parameters List<Property Map>

A list of Redshift parameters to apply.

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.

You can read more about the parameters that Redshift supports in the documentation

Outputs

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

Arn string: Amazon Resource Name (ARN) of 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: Amazon Resource Name (ARN) of 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: Amazon Resource Name (ARN) of 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: Amazon Resource Name (ARN) of 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: Amazon Resource Name (ARN) of 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: Amazon Resource Name (ARN) of 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:redshift: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

Amazon Resource Name (ARN) of parameter group

Description string

The description of the Redshift parameter group. Defaults to "Managed by Pulumi".

Family string

The family of the Redshift parameter group.

Name string

The name of the Redshift parameter.

Parameters List<ParameterGroupParameter>

A list of Redshift parameters to apply.

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.

You can read more about the parameters that Redshift supports in the documentation

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

Amazon Resource Name (ARN) of parameter group

Description string

The description of the Redshift parameter group. Defaults to "Managed by Pulumi".

Family string

The family of the Redshift parameter group.

Name string

The name of the Redshift parameter.

Parameters []ParameterGroupParameterArgs

A list of Redshift parameters to apply.

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.

You can read more about the parameters that Redshift supports in the documentation

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

Amazon Resource Name (ARN) of parameter group

description String

The description of the Redshift parameter group. Defaults to "Managed by Pulumi".

family String

The family of the Redshift parameter group.

name String

The name of the Redshift parameter.

parameters List<ParameterGroupParameter>

A list of Redshift parameters to apply.

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.

You can read more about the parameters that Redshift supports in the documentation

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

Amazon Resource Name (ARN) of parameter group

description string

The description of the Redshift parameter group. Defaults to "Managed by Pulumi".

family string

The family of the Redshift parameter group.

name string

The name of the Redshift parameter.

parameters ParameterGroupParameter[]

A list of Redshift parameters to apply.

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.

You can read more about the parameters that Redshift supports in the documentation

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

Amazon Resource Name (ARN) of parameter group

description str

The description of the Redshift parameter group. Defaults to "Managed by Pulumi".

family str

The family of the Redshift parameter group.

name str

The name of the Redshift parameter.

parameters Sequence[ParameterGroupParameterArgs]

A list of Redshift parameters to apply.

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.

You can read more about the parameters that Redshift supports in the documentation

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

Amazon Resource Name (ARN) of parameter group

description String

The description of the Redshift parameter group. Defaults to "Managed by Pulumi".

family String

The family of the Redshift parameter group.

name String

The name of the Redshift parameter.

parameters List<Property Map>

A list of Redshift parameters to apply.

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.

You can read more about the parameters that Redshift supports in the documentation

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 Redshift parameter.
Value string: The value of the Redshift parameter.

Name string: The name of the Redshift parameter.
Value string: The value of the Redshift parameter.

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

name string: The name of the Redshift parameter.
value string: The value of the Redshift parameter.

name str: The name of the Redshift parameter.
value str: The value of the Redshift parameter.

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

Import

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

$ pulumi import aws:redshift/parameterGroup:ParameterGroup paramgroup1 parameter-group-test-pulumi

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.75.0 published on Wednesday, Apr 2, 2025 by Pulumi

pulumi/pulumi-aws

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