aws logo
AWS Classic v5.29.0, Feb 1 23

aws.redshift.SubnetGroup

Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var fooVpc = new Aws.Ec2.Vpc("fooVpc", new()
    {
        CidrBlock = "10.1.0.0/16",
    });

    var fooSubnet = new Aws.Ec2.Subnet("fooSubnet", new()
    {
        CidrBlock = "10.1.1.0/24",
        AvailabilityZone = "us-west-2a",
        VpcId = fooVpc.Id,
        Tags = 
        {
            { "Name", "tf-dbsubnet-test-1" },
        },
    });

    var bar = new Aws.Ec2.Subnet("bar", new()
    {
        CidrBlock = "10.1.2.0/24",
        AvailabilityZone = "us-west-2b",
        VpcId = fooVpc.Id,
        Tags = 
        {
            { "Name", "tf-dbsubnet-test-2" },
        },
    });

    var fooSubnetGroup = new Aws.RedShift.SubnetGroup("fooSubnetGroup", new()
    {
        SubnetIds = new[]
        {
            fooSubnet.Id,
            bar.Id,
        },
        Tags = 
        {
            { "environment", "Production" },
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooVpc, err := ec2.NewVpc(ctx, "fooVpc", &ec2.VpcArgs{
			CidrBlock: pulumi.String("10.1.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := ec2.NewSubnet(ctx, "fooSubnet", &ec2.SubnetArgs{
			CidrBlock:        pulumi.String("10.1.1.0/24"),
			AvailabilityZone: pulumi.String("us-west-2a"),
			VpcId:            fooVpc.ID(),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("tf-dbsubnet-test-1"),
			},
		})
		if err != nil {
			return err
		}
		bar, err := ec2.NewSubnet(ctx, "bar", &ec2.SubnetArgs{
			CidrBlock:        pulumi.String("10.1.2.0/24"),
			AvailabilityZone: pulumi.String("us-west-2b"),
			VpcId:            fooVpc.ID(),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("tf-dbsubnet-test-2"),
			},
		})
		if err != nil {
			return err
		}
		_, err = redshift.NewSubnetGroup(ctx, "fooSubnetGroup", &redshift.SubnetGroupArgs{
			SubnetIds: pulumi.StringArray{
				fooSubnet.ID(),
				bar.ID(),
			},
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		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.ec2.Vpc;
import com.pulumi.aws.ec2.VpcArgs;
import com.pulumi.aws.ec2.Subnet;
import com.pulumi.aws.ec2.SubnetArgs;
import com.pulumi.aws.redshift.SubnetGroup;
import com.pulumi.aws.redshift.SubnetGroupArgs;
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 fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .cidrBlock("10.1.0.0/16")
            .build());

        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .cidrBlock("10.1.1.0/24")
            .availabilityZone("us-west-2a")
            .vpcId(fooVpc.id())
            .tags(Map.of("Name", "tf-dbsubnet-test-1"))
            .build());

        var bar = new Subnet("bar", SubnetArgs.builder()        
            .cidrBlock("10.1.2.0/24")
            .availabilityZone("us-west-2b")
            .vpcId(fooVpc.id())
            .tags(Map.of("Name", "tf-dbsubnet-test-2"))
            .build());

        var fooSubnetGroup = new SubnetGroup("fooSubnetGroup", SubnetGroupArgs.builder()        
            .subnetIds(            
                fooSubnet.id(),
                bar.id())
            .tags(Map.of("environment", "Production"))
            .build());

    }
}
import pulumi
import pulumi_aws as aws

foo_vpc = aws.ec2.Vpc("fooVpc", cidr_block="10.1.0.0/16")
foo_subnet = aws.ec2.Subnet("fooSubnet",
    cidr_block="10.1.1.0/24",
    availability_zone="us-west-2a",
    vpc_id=foo_vpc.id,
    tags={
        "Name": "tf-dbsubnet-test-1",
    })
bar = aws.ec2.Subnet("bar",
    cidr_block="10.1.2.0/24",
    availability_zone="us-west-2b",
    vpc_id=foo_vpc.id,
    tags={
        "Name": "tf-dbsubnet-test-2",
    })
foo_subnet_group = aws.redshift.SubnetGroup("fooSubnetGroup",
    subnet_ids=[
        foo_subnet.id,
        bar.id,
    ],
    tags={
        "environment": "Production",
    })
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const fooVpc = new aws.ec2.Vpc("fooVpc", {cidrBlock: "10.1.0.0/16"});
const fooSubnet = new aws.ec2.Subnet("fooSubnet", {
    cidrBlock: "10.1.1.0/24",
    availabilityZone: "us-west-2a",
    vpcId: fooVpc.id,
    tags: {
        Name: "tf-dbsubnet-test-1",
    },
});
const bar = new aws.ec2.Subnet("bar", {
    cidrBlock: "10.1.2.0/24",
    availabilityZone: "us-west-2b",
    vpcId: fooVpc.id,
    tags: {
        Name: "tf-dbsubnet-test-2",
    },
});
const fooSubnetGroup = new aws.redshift.SubnetGroup("fooSubnetGroup", {
    subnetIds: [
        fooSubnet.id,
        bar.id,
    ],
    tags: {
        environment: "Production",
    },
});
resources:
  fooVpc:
    type: aws:ec2:Vpc
    properties:
      cidrBlock: 10.1.0.0/16
  fooSubnet:
    type: aws:ec2:Subnet
    properties:
      cidrBlock: 10.1.1.0/24
      availabilityZone: us-west-2a
      vpcId: ${fooVpc.id}
      tags:
        Name: tf-dbsubnet-test-1
  bar:
    type: aws:ec2:Subnet
    properties:
      cidrBlock: 10.1.2.0/24
      availabilityZone: us-west-2b
      vpcId: ${fooVpc.id}
      tags:
        Name: tf-dbsubnet-test-2
  fooSubnetGroup:
    type: aws:redshift:SubnetGroup
    properties:
      subnetIds:
        - ${fooSubnet.id}
        - ${bar.id}
      tags:
        environment: Production

Create SubnetGroup Resource

new SubnetGroup(name: string, args: SubnetGroupArgs, opts?: CustomResourceOptions);
@overload
def SubnetGroup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                description: Optional[str] = None,
                name: Optional[str] = None,
                subnet_ids: Optional[Sequence[str]] = None,
                tags: Optional[Mapping[str, str]] = None)
@overload
def SubnetGroup(resource_name: str,
                args: SubnetGroupArgs,
                opts: Optional[ResourceOptions] = None)
func NewSubnetGroup(ctx *Context, name string, args SubnetGroupArgs, opts ...ResourceOption) (*SubnetGroup, error)
public SubnetGroup(string name, SubnetGroupArgs args, CustomResourceOptions? opts = null)
public SubnetGroup(String name, SubnetGroupArgs args)
public SubnetGroup(String name, SubnetGroupArgs args, CustomResourceOptions options)
type: aws:redshift:SubnetGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args SubnetGroupArgs
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 SubnetGroupArgs
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 SubnetGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SubnetGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args SubnetGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

SubnetGroup 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 SubnetGroup resource accepts the following input properties:

SubnetIds List<string>

An array of VPC subnet IDs.

Description string

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

Name string

The name of the Redshift Subnet group.

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.

SubnetIds []string

An array of VPC subnet IDs.

Description string

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

Name string

The name of the Redshift Subnet group.

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.

subnetIds List<String>

An array of VPC subnet IDs.

description String

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

name String

The name of the Redshift Subnet group.

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.

subnetIds string[]

An array of VPC subnet IDs.

description string

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

name string

The name of the Redshift Subnet group.

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.

subnet_ids Sequence[str]

An array of VPC subnet IDs.

description str

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

name str

The name of the Redshift Subnet group.

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.

subnetIds List<String>

An array of VPC subnet IDs.

description String

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

name String

The name of the Redshift Subnet group.

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 SubnetGroup resource produces the following output properties:

Arn string

Amazon Resource Name (ARN) of the Redshift Subnet group name

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.

Arn string

Amazon Resource Name (ARN) of the Redshift Subnet group name

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.

arn String

Amazon Resource Name (ARN) of the Redshift Subnet group name

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.

arn string

Amazon Resource Name (ARN) of the Redshift Subnet group name

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.

arn str

Amazon Resource Name (ARN) of the Redshift Subnet group name

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.

arn String

Amazon Resource Name (ARN) of the Redshift Subnet group name

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.

Look up Existing SubnetGroup Resource

Get an existing SubnetGroup 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?: SubnetGroupState, opts?: CustomResourceOptions): SubnetGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        subnet_ids: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> SubnetGroup
func GetSubnetGroup(ctx *Context, name string, id IDInput, state *SubnetGroupState, opts ...ResourceOption) (*SubnetGroup, error)
public static SubnetGroup Get(string name, Input<string> id, SubnetGroupState? state, CustomResourceOptions? opts = null)
public static SubnetGroup get(String name, Output<String> id, SubnetGroupState 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

Amazon Resource Name (ARN) of the Redshift Subnet group name

Description string

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

Name string

The name of the Redshift Subnet group.

SubnetIds List<string>

An array of VPC subnet IDs.

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.

Arn string

Amazon Resource Name (ARN) of the Redshift Subnet group name

Description string

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

Name string

The name of the Redshift Subnet group.

SubnetIds []string

An array of VPC subnet IDs.

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.

arn String

Amazon Resource Name (ARN) of the Redshift Subnet group name

description String

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

name String

The name of the Redshift Subnet group.

subnetIds List<String>

An array of VPC subnet IDs.

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.

arn string

Amazon Resource Name (ARN) of the Redshift Subnet group name

description string

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

name string

The name of the Redshift Subnet group.

subnetIds string[]

An array of VPC subnet IDs.

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.

arn str

Amazon Resource Name (ARN) of the Redshift Subnet group name

description str

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

name str

The name of the Redshift Subnet group.

subnet_ids Sequence[str]

An array of VPC subnet IDs.

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.

arn String

Amazon Resource Name (ARN) of the Redshift Subnet group name

description String

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

name String

The name of the Redshift Subnet group.

subnetIds List<String>

An array of VPC subnet IDs.

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.

Import

Redshift subnet groups can be imported using the name, e.g.,

 $ pulumi import aws:redshift/subnetGroup:SubnetGroup testgroup1 test-cluster-subnet-group

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.