SubnetGroup

Provides an DocumentDB subnet group resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var @default = new Aws.DocDB.SubnetGroup("default", new Aws.DocDB.SubnetGroupArgs
        {
            SubnetIds = 
            {
                aws_subnet.Frontend.Id,
                aws_subnet.Backend.Id,
            },
            Tags = 
            {
                { "Name", "My docdb subnet group" },
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/docdb"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := docdb.NewSubnetGroup(ctx, "_default", &docdb.SubnetGroupArgs{
            SubnetIds: pulumi.StringArray{
                pulumi.String(aws_subnet.Frontend.Id),
                pulumi.String(aws_subnet.Backend.Id),
            },
            Tags: pulumi.StringMap{
                "Name": pulumi.String("My docdb subnet group"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

default = aws.docdb.SubnetGroup("default",
    subnet_ids=[
        aws_subnet["frontend"]["id"],
        aws_subnet["backend"]["id"],
    ],
    tags={
        "Name": "My docdb subnet group",
    })

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

const defaultSubnetGroup = new aws.docdb.SubnetGroup("default", {
    subnetIds: [
        aws_subnet_frontend.id,
        aws_subnet_backend.id,
    ],
    tags: {
        Name: "My docdb subnet group",
    },
});

Create a SubnetGroup Resource

new SubnetGroup(name: string, args: SubnetGroupArgs, opts?: CustomResourceOptions);

def SubnetGroup(resource_name, opts=None, description=None, name=None, name_prefix=None, subnet_ids=None, tags=None, __props__=None);

func NewSubnetGroup(ctx *Context, name string, args SubnetGroupArgs, opts ...ResourceOption) (*SubnetGroup, error)

public SubnetGroup(string name, SubnetGroupArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

SubnetGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The SubnetGroup resource accepts the following input properties:

SubnetIds List<string>: A list of VPC subnet IDs.
Description string: The description of the docDB subnet group. Defaults to “Managed by Pulumi”.
Name string: The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

SubnetIds []string: A list of VPC subnet IDs.
Description string: The description of the docDB subnet group. Defaults to “Managed by Pulumi”.
Name string: The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
Tags map[string]string: A map of tags to assign to the resource.

subnetIds string[]: A list of VPC subnet IDs.
description string: The description of the docDB subnet group. Defaults to “Managed by Pulumi”.
name string: The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
namePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
tags {[key: string]: string}: A map of tags to assign to the resource.

subnet_ids List[str]: A list of VPC subnet IDs.
description str: The description of the docDB subnet group. Defaults to “Managed by Pulumi”.
name str: The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
name_prefix str: Creates a unique name beginning with the specified prefix. Conflicts with name.
tags Dict[str, str]: A map of tags to assign to the resource.

Outputs

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

Arn string: The ARN of the docDB subnet group.
Id string: The provider-assigned unique ID for this managed resource.

Arn string: The ARN of the docDB subnet group.
Id string: The provider-assigned unique ID for this managed resource.

arn string: The ARN of the docDB subnet group.
id string: The provider-assigned unique ID for this managed resource.

arn str: The ARN of the docDB subnet group.
id str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, arn=None, description=None, name=None, name_prefix=None, subnet_ids=None, tags=None, __props__=None);

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)

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.

The following state arguments are supported:

Arn string: The ARN of the docDB subnet group.
Description string: The description of the docDB subnet group. Defaults to “Managed by Pulumi”.
Name string: The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
SubnetIds List<string>: A list of VPC subnet IDs.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

Arn string: The ARN of the docDB subnet group.
Description string: The description of the docDB subnet group. Defaults to “Managed by Pulumi”.
Name string: The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
SubnetIds []string: A list of VPC subnet IDs.
Tags map[string]string: A map of tags to assign to the resource.

arn string: The ARN of the docDB subnet group.
description string: The description of the docDB subnet group. Defaults to “Managed by Pulumi”.
name string: The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
namePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
subnetIds string[]: A list of VPC subnet IDs.
tags {[key: string]: string}: A map of tags to assign to the resource.

arn str: The ARN of the docDB subnet group.
description str: The description of the docDB subnet group. Defaults to “Managed by Pulumi”.
name str: The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
name_prefix str: Creates a unique name beginning with the specified prefix. Conflicts with name.
subnet_ids List[str]: A list of VPC subnet IDs.
tags Dict[str, str]: A map of tags to assign to the resource.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud