1. Packages
  2. AWS Classic
  3. API Docs
  4. rds
  5. SubnetGroup

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

aws.rds.SubnetGroup

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

    Provides an RDS DB subnet group resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const _default = new aws.rds.SubnetGroup("default", {
        name: "main",
        subnetIds: [
            frontend.id,
            backend.id,
        ],
        tags: {
            Name: "My DB subnet group",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    default = aws.rds.SubnetGroup("default",
        name="main",
        subnet_ids=[
            frontend["id"],
            backend["id"],
        ],
        tags={
            "Name": "My DB subnet group",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := rds.NewSubnetGroup(ctx, "default", &rds.SubnetGroupArgs{
    			Name: pulumi.String("main"),
    			SubnetIds: pulumi.StringArray{
    				frontend.Id,
    				backend.Id,
    			},
    			Tags: pulumi.StringMap{
    				"Name": pulumi.String("My DB subnet group"),
    			},
    		})
    		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 @default = new Aws.Rds.SubnetGroup("default", new()
        {
            Name = "main",
            SubnetIds = new[]
            {
                frontend.Id,
                backend.Id,
            },
            Tags = 
            {
                { "Name", "My DB subnet group" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.rds.SubnetGroup;
    import com.pulumi.aws.rds.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 DB subnet group"))
                .build());
    
        }
    }
    
    resources:
      default:
        type: aws:rds:SubnetGroup
        properties:
          name: main
          subnetIds:
            - ${frontend.id}
            - ${backend.id}
          tags:
            Name: My DB subnet group
    

    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:rds:SubnetGroup
    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 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.

    Example

    The following reference example uses placeholder values for all input properties.

    var examplesubnetGroupResourceResourceFromRdssubnetGroup = new Aws.Rds.SubnetGroup("examplesubnetGroupResourceResourceFromRdssubnetGroup", new()
    {
        SubnetIds = new[]
        {
            "string",
        },
        Description = "string",
        Name = "string",
        NamePrefix = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := rds.NewSubnetGroup(ctx, "examplesubnetGroupResourceResourceFromRdssubnetGroup", &rds.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"),
    	},
    })
    
    var examplesubnetGroupResourceResourceFromRdssubnetGroup = new SubnetGroup("examplesubnetGroupResourceResourceFromRdssubnetGroup", SubnetGroupArgs.builder()
        .subnetIds("string")
        .description("string")
        .name("string")
        .namePrefix("string")
        .tags(Map.of("string", "string"))
        .build());
    
    examplesubnet_group_resource_resource_from_rdssubnet_group = aws.rds.SubnetGroup("examplesubnetGroupResourceResourceFromRdssubnetGroup",
        subnet_ids=["string"],
        description="string",
        name="string",
        name_prefix="string",
        tags={
            "string": "string",
        })
    
    const examplesubnetGroupResourceResourceFromRdssubnetGroup = new aws.rds.SubnetGroup("examplesubnetGroupResourceResourceFromRdssubnetGroup", {
        subnetIds: ["string"],
        description: "string",
        name: "string",
        namePrefix: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:rds:SubnetGroup
    properties:
        description: string
        name: string
        namePrefix: string
        subnetIds:
            - string
        tags:
            string: string
    

    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>
    A list of VPC subnet IDs.
    Description string
    The description of the DB subnet group. Defaults to "Managed by Pulumi".
    Name string
    The name of the DB subnet group. If omitted, the 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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    SubnetIds []string
    A list of VPC subnet IDs.
    Description string
    The description of the DB subnet group. Defaults to "Managed by Pulumi".
    Name string
    The name of the DB subnet group. If omitted, the 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. 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>
    A list of VPC subnet IDs.
    description String
    The description of the DB subnet group. Defaults to "Managed by Pulumi".
    name String
    The name of the DB subnet group. If omitted, the 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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    subnetIds string[]
    A list of VPC subnet IDs.
    description string
    The description of the DB subnet group. Defaults to "Managed by Pulumi".
    name string
    The name of the DB subnet group. If omitted, the 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. 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]
    A list of VPC subnet IDs.
    description str
    The description of the DB subnet group. Defaults to "Managed by Pulumi".
    name str
    The name of the DB subnet group. If omitted, the provider will assign a random, unique name.
    name_prefix 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 List<String>
    A list of VPC subnet IDs.
    description String
    The description of the DB subnet group. Defaults to "Managed by Pulumi".
    name String
    The name of the DB subnet group. If omitted, the provider will assign a random, unique name.
    namePrefix 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 db subnet group.
    Id string
    The provider-assigned unique ID for this managed resource.
    SupportedNetworkTypes List<string>
    The network type of the db subnet group.
    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.

    VpcId string
    Provides the VPC ID of the DB subnet group.
    Arn string
    The ARN of the db subnet group.
    Id string
    The provider-assigned unique ID for this managed resource.
    SupportedNetworkTypes []string
    The network type of the db subnet group.
    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.

    VpcId string
    Provides the VPC ID of the DB subnet group.
    arn String
    The ARN of the db subnet group.
    id String
    The provider-assigned unique ID for this managed resource.
    supportedNetworkTypes List<String>
    The network type of the db subnet group.
    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.

    vpcId String
    Provides the VPC ID of the DB subnet group.
    arn string
    The ARN of the db subnet group.
    id string
    The provider-assigned unique ID for this managed resource.
    supportedNetworkTypes string[]
    The network type of the db subnet group.
    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.

    vpcId string
    Provides the VPC ID of the DB subnet group.
    arn str
    The ARN of the db subnet group.
    id str
    The provider-assigned unique ID for this managed resource.
    supported_network_types Sequence[str]
    The network type of the db subnet group.
    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.

    vpc_id str
    Provides the VPC ID of the DB subnet group.
    arn String
    The ARN of the db subnet group.
    id String
    The provider-assigned unique ID for this managed resource.
    supportedNetworkTypes List<String>
    The network type of the db subnet group.
    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.

    vpcId String
    Provides the VPC ID of the DB subnet group.

    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,
            supported_network_types: Optional[Sequence[str]] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            vpc_id: Optional[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
    The ARN of the db subnet group.
    Description string
    The description of the DB subnet group. Defaults to "Managed by Pulumi".
    Name string
    The name of the DB subnet group. If omitted, the 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.
    SupportedNetworkTypes List<string>
    The network type of the db 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.
    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.

    VpcId string
    Provides the VPC ID of the DB subnet group.
    Arn string
    The ARN of the db subnet group.
    Description string
    The description of the DB subnet group. Defaults to "Managed by Pulumi".
    Name string
    The name of the DB subnet group. If omitted, the 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.
    SupportedNetworkTypes []string
    The network type of the db 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.
    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.

    VpcId string
    Provides the VPC ID of the DB subnet group.
    arn String
    The ARN of the db subnet group.
    description String
    The description of the DB subnet group. Defaults to "Managed by Pulumi".
    name String
    The name of the DB subnet group. If omitted, the 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.
    supportedNetworkTypes List<String>
    The network type of the db 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.
    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.

    vpcId String
    Provides the VPC ID of the DB subnet group.
    arn string
    The ARN of the db subnet group.
    description string
    The description of the DB subnet group. Defaults to "Managed by Pulumi".
    name string
    The name of the DB subnet group. If omitted, the 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.
    supportedNetworkTypes string[]
    The network type of the db 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.
    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.

    vpcId string
    Provides the VPC ID of the DB subnet group.
    arn str
    The ARN of the db subnet group.
    description str
    The description of the DB subnet group. Defaults to "Managed by Pulumi".
    name str
    The name of the DB subnet group. If omitted, the provider will assign a random, unique name.
    name_prefix str
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    subnet_ids Sequence[str]
    A list of VPC subnet IDs.
    supported_network_types Sequence[str]
    The network type of the db 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.
    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.

    vpc_id str
    Provides the VPC ID of the DB subnet group.
    arn String
    The ARN of the db subnet group.
    description String
    The description of the DB subnet group. Defaults to "Managed by Pulumi".
    name String
    The name of the DB subnet group. If omitted, the 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.
    supportedNetworkTypes List<String>
    The network type of the db 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.
    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.

    vpcId String
    Provides the VPC ID of the DB subnet group.

    Import

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

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

    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 logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi