Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. docdb
  5. SubnetGroup
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.docdb.SubnetGroup

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Provides an DocumentDB subnet group resource.

Example Usage

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

const _default = new aws.docdb.SubnetGroup("default", {
    name: "main",
    subnetIds: [
        frontend.id,
        backend.id,
    ],
    tags: {
        Name: "My docdb subnet group",
    },
});
Copy
import pulumi
import pulumi_aws as aws

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

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := docdb.NewSubnetGroup(ctx, "default", &docdb.SubnetGroupArgs{
			Name: pulumi.String("main"),
			SubnetIds: pulumi.StringArray{
				frontend.Id,
				backend.Id,
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("My docdb subnet group"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var @default = new Aws.DocDB.SubnetGroup("default", new()
    {
        Name = "main",
        SubnetIds = new[]
        {
            frontend.Id,
            backend.Id,
        },
        Tags = 
        {
            { "Name", "My docdb subnet group" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.docdb.SubnetGroup;
import com.pulumi.aws.docdb.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 default_ = new SubnetGroup("default", SubnetGroupArgs.builder()
            .name("main")
            .subnetIds(            
                frontend.id(),
                backend.id())
            .tags(Map.of("Name", "My docdb subnet group"))
            .build());

    }
}
Copy
resources:
  default:
    type: aws:docdb:SubnetGroup
    properties:
      name: main
      subnetIds:
        - ${frontend.id}
        - ${backend.id}
      tags:
        Name: My docdb subnet group
Copy

Create SubnetGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SubnetGroup(name: string, args: SubnetGroupArgs, opts?: CustomResourceOptions);
@overload
def SubnetGroup(resource_name: str,
                args: SubnetGroupArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def SubnetGroup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                subnet_ids: Optional[Sequence[str]] = None,
                description: Optional[str] = None,
                name: Optional[str] = None,
                name_prefix: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = 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:docdb:SubnetGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

var awsSubnetGroupResource = new Aws.DocDB.SubnetGroup("awsSubnetGroupResource", new()
{
    SubnetIds = new[]
    {
        "string",
    },
    Description = "string",
    Name = "string",
    NamePrefix = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := docdb.NewSubnetGroup(ctx, "awsSubnetGroupResource", &docdb.SubnetGroupArgs{
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	NamePrefix:  pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var awsSubnetGroupResource = new SubnetGroup("awsSubnetGroupResource", SubnetGroupArgs.builder()
    .subnetIds("string")
    .description("string")
    .name("string")
    .namePrefix("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
aws_subnet_group_resource = aws.docdb.SubnetGroup("awsSubnetGroupResource",
    subnet_ids=["string"],
    description="string",
    name="string",
    name_prefix="string",
    tags={
        "string": "string",
    })
Copy
const awsSubnetGroupResource = new aws.docdb.SubnetGroup("awsSubnetGroupResource", {
    subnetIds: ["string"],
    description: "string",
    name: "string",
    namePrefix: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:docdb:SubnetGroup
properties:
    description: string
    name: string
    namePrefix: string
    subnetIds:
        - string
    tags:
        string: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SubnetGroup resource accepts the following input properties:

SubnetIds This property is required. List<string>
A list of VPC subnet IDs.
Description string
The description of the docDB subnet group. Defaults to "Managed by Pulumi".
Name Changes to this property will trigger replacement. string
The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
NamePrefix Changes to this property will trigger replacement. 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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
SubnetIds This property is required. []string
A list of VPC subnet IDs.
Description string
The description of the docDB subnet group. Defaults to "Managed by Pulumi".
Name Changes to this property will trigger replacement. string
The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
NamePrefix Changes to this property will trigger replacement. 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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
subnetIds This property is required. List<String>
A list of VPC subnet IDs.
description String
The description of the docDB subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. String
The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
namePrefix Changes to this property will trigger replacement. 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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
subnetIds This property is required. string[]
A list of VPC subnet IDs.
description string
The description of the docDB subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. string
The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
namePrefix Changes to this property will trigger replacement. 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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
subnet_ids This property is required. Sequence[str]
A list of VPC subnet IDs.
description str
The description of the docDB subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. str
The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
name_prefix Changes to this property will trigger replacement. str
Creates a unique name beginning with the specified prefix. Conflicts with name.
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 This property is required. List<String>
A list of VPC subnet IDs.
description String
The description of the docDB subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. String
The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
namePrefix Changes to this property will trigger replacement. String
Creates a unique name beginning with the specified prefix. Conflicts with name.
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
The ARN of the docDB subnet 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
The ARN of the docDB subnet 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
The ARN of the docDB subnet 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
The ARN of the docDB subnet 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
The ARN of the docDB subnet 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
The ARN of the docDB subnet 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 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,
        name_prefix: 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)
resources:  _:    type: aws:docdb:SubnetGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. string
The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
NamePrefix Changes to this property will trigger replacement. 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. .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.

Deprecated: Please use tags instead.

Arn string
The ARN of the docDB subnet group.
Description string
The description of the docDB subnet group. Defaults to "Managed by Pulumi".
Name Changes to this property will trigger replacement. string
The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
NamePrefix Changes to this property will trigger replacement. 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. .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.

Deprecated: Please use tags instead.

arn String
The ARN of the docDB subnet group.
description String
The description of the docDB subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. String
The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
namePrefix Changes to this property will trigger replacement. String
Creates a unique name beginning with the specified prefix. Conflicts with name.
subnetIds List<String>
A list 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.

Deprecated: Please use tags instead.

arn string
The ARN of the docDB subnet group.
description string
The description of the docDB subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. string
The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
namePrefix Changes to this property will trigger replacement. 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. .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.

Deprecated: Please use tags instead.

arn str
The ARN of the docDB subnet group.
description str
The description of the docDB subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. str
The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
name_prefix Changes to this property will trigger replacement. str
Creates a unique name beginning with the specified prefix. Conflicts with name.
subnet_ids Sequence[str]
A list 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.

Deprecated: Please use tags instead.

arn String
The ARN of the docDB subnet group.
description String
The description of the docDB subnet group. Defaults to "Managed by Pulumi".
name Changes to this property will trigger replacement. String
The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.
namePrefix Changes to this property will trigger replacement. String
Creates a unique name beginning with the specified prefix. Conflicts with name.
subnetIds List<String>
A list 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.

Deprecated: Please use tags instead.

Import

Using pulumi import, import DocumentDB Subnet groups using the name. For example:

$ pulumi import aws:docdb/subnetGroup:SubnetGroup default production-subnet-group
Copy

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.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws