SubnetGroup class

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

Example Usage

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

const foo = new aws.ec2.Vpc("foo", {cidrBlock: "10.1.0.0/16"});
const fooSubnet = new aws.ec2.Subnet("foo", {
    cidrBlock: "10.1.1.0/24",
    availabilityZone: "us-west-2a",
    vpcId: foo.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: foo.id,
    tags: {
        Name: "tf-dbsubnet-test-2",
    },
});
const fooSubnetGroup = new aws.redshift.SubnetGroup("foo", {
    name: "foo",
    subnetIds: [
        fooSubnet.id,
        bar.id,
    ],
    tags: {
        environment: "Production",
    },
});
import pulumi
import pulumi_aws as aws

foo = aws.ec2.Vpc("foo", cidr_block="10.1.0.0/16")
foo_subnet = aws.ec2.Subnet("foo",
    cidr_block="10.1.1.0/24",
    availability_zone="us-west-2a",
    vpc_id=foo.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.id,
    tags={
        "Name": "tf-dbsubnet-test-2",
    })
foo_subnet_group = aws.redshift.SubnetGroup("foo",
    name="foo",
    subnet_ids=[
        foo_subnet.id,
        bar.id,
    ],
    tags={
        "environment": "Production",
    })
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

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

    var fooSubnet = new Aws.Ec2.Subnet("foo", new()
    {
        CidrBlock = "10.1.1.0/24",
        AvailabilityZone = "us-west-2a",
        VpcId = foo.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 = foo.Id,
        Tags =
        {
            { "Name", "tf-dbsubnet-test-2" },
        },
    });

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

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		foo, err := ec2.NewVpc(ctx, "foo", &ec2.VpcArgs{
			CidrBlock: pulumi.String("10.1.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := ec2.NewSubnet(ctx, "foo", &ec2.SubnetArgs{
			CidrBlock:        pulumi.String("10.1.1.0/24"),
			AvailabilityZone: pulumi.String("us-west-2a"),
			VpcId:            foo.ID().ToIDOutput().ToStringOutput(),
			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:            foo.ID().ToIDOutput().ToStringOutput(),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("tf-dbsubnet-test-2"),
			},
		})
		if err != nil {
			return err
		}
		_, err = redshift.NewSubnetGroup(ctx, "foo", &redshift.SubnetGroupArgs{
			Name: pulumi.String("foo"),
			SubnetIds: pulumi.StringArray{
				fooSubnet.ID().ToIDOutput().ToStringOutput(),
				bar.ID().ToIDOutput().ToStringOutput(),
			},
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ec2_vpc" "foo" {
  cidr_block = "10.1.0.0/16"
}
resource "aws_ec2_subnet" "foo" {
  cidr_block        = "10.1.1.0/24"
  availability_zone = "us-west-2a"
  vpc_id            = aws_ec2_vpc.foo.id
  tags = {
    "Name" = "tf-dbsubnet-test-1"
  }
}
resource "aws_ec2_subnet" "bar" {
  cidr_block        = "10.1.2.0/24"
  availability_zone = "us-west-2b"
  vpc_id            = aws_ec2_vpc.foo.id
  tags = {
    "Name" = "tf-dbsubnet-test-2"
  }
}
resource "aws_redshift_subnetgroup" "foo" {
  name       = "foo"
  subnet_ids = [aws_ec2_subnet.foo.id, aws_ec2_subnet.bar.id]
  tags = {
    "environment" = "Production"
  }
}
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.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 foo = new Vpc("foo", 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(foo.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(foo.id())
            .tags(Map.of("Name", "tf-dbsubnet-test-2"))
            .build());

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

    }
}
resources:
  foo:
    type: aws:ec2:Vpc
    properties:
      cidrBlock: 10.1.0.0/16
  fooSubnet:
    type: aws:ec2:Subnet
    name: foo
    properties:
      cidrBlock: 10.1.1.0/24
      availabilityZone: us-west-2a
      vpcId: ${foo.id}
      tags:
        Name: tf-dbsubnet-test-1
  bar:
    type: aws:ec2:Subnet
    properties:
      cidrBlock: 10.1.2.0/24
      availabilityZone: us-west-2b
      vpcId: ${foo.id}
      tags:
        Name: tf-dbsubnet-test-2
  fooSubnetGroup:
    type: aws:redshift:SubnetGroup
    name: foo
    properties:
      name: foo
      subnetIds:
        - ${fooSubnet.id}
        - ${bar.id}
      tags:
        environment: Production

Import

Using pulumi import, import Redshift subnet groups using the name. For example:

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

Constructors

SubnetGroup(String name, {SubnetGroupArgs? args, CustomResourceOptions? options})
Creates a new SubnetGroup. name The Pulumi resource name. args Arguments used to configure this SubnetGroup. The set of arguments for SubnetGroup. options Resource options controlling this resource's behavior.
SubnetGroup.reference(String urn)
Creates a typed reference to an existing SubnetGroup resource.

Properties

arn ↔ Output<String>
ARN of the Redshift Subnet group name
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
description ↔ Output<String>
The description of the Redshift Subnet group. Defaults to "Managed by Pulumi".
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 Redshift Subnet group.
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
subnetIds ↔ Output<List<String>>
An array of VPC subnet IDs.
latefinal
tags ↔ Output<Map<String, String>?>
A map of tags to assign to the resource. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration 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, {SubnetGroupState? state, CustomResourceOptions? options}) → SubnetGroup
Gets an existing SubnetGroup resource's state with the given name and id.