1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. docdb
  6. getDbSubnetGroup

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.79.0
published on Monday, Sep 14, 2026 by Pulumi
aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.79.0
published on Monday, Sep 14, 2026 by Pulumi

    Resource Type definition for AWS::DocDB::DBSubnetGroup

    Using getDbSubnetGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDbSubnetGroup(args: GetDbSubnetGroupArgs, opts?: InvokeOptions): Promise<GetDbSubnetGroupResult>
    function getDbSubnetGroupOutput(args: GetDbSubnetGroupOutputArgs, opts?: InvokeOutputOptions): Output<GetDbSubnetGroupResult>
    def get_db_subnet_group(db_subnet_group_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetDbSubnetGroupResult
    def get_db_subnet_group_output(db_subnet_group_name: pulumi.Input[Optional[str]] = None,
                            opts: Optional[InvokeOutputOptions] = None) -> Output[GetDbSubnetGroupResult]
    func LookupDbSubnetGroup(ctx *Context, args *LookupDbSubnetGroupArgs, opts ...InvokeOption) (*LookupDbSubnetGroupResult, error)
    func LookupDbSubnetGroupOutput(ctx *Context, args *LookupDbSubnetGroupOutputArgs, opts ...InvokeOption) LookupDbSubnetGroupResultOutput

    > Note: This function is named LookupDbSubnetGroup in the Go SDK.

    public static class GetDbSubnetGroup 
    {
        public static Task<GetDbSubnetGroupResult> InvokeAsync(GetDbSubnetGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetDbSubnetGroupResult> Invoke(GetDbSubnetGroupInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetDbSubnetGroupResult> Invoke(GetDbSubnetGroupInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetDbSubnetGroupResult> getDbSubnetGroup(GetDbSubnetGroupArgs args, InvokeOptions options)
    public static Output<GetDbSubnetGroupResult> getDbSubnetGroup(GetDbSubnetGroupArgs args, InvokeOptions options)
    public static Output<GetDbSubnetGroupResult> getDbSubnetGroup(GetDbSubnetGroupArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: aws-native:docdb:getDbSubnetGroup
      arguments:
        # arguments dictionary
    data "aws-native_docdb_get_db_subnet_group" "name" {
        # arguments
    }

    The following arguments are supported:

    DbSubnetGroupName string
    The name for the db subnet group. This value is stored as a lowercase string.
    DbSubnetGroupName string
    The name for the db subnet group. This value is stored as a lowercase string.
    db_subnet_group_name string
    The name for the db subnet group. This value is stored as a lowercase string.
    dbSubnetGroupName String
    The name for the db subnet group. This value is stored as a lowercase string.
    dbSubnetGroupName string
    The name for the db subnet group. This value is stored as a lowercase string.
    db_subnet_group_name str
    The name for the db subnet group. This value is stored as a lowercase string.
    dbSubnetGroupName String
    The name for the db subnet group. This value is stored as a lowercase string.

    getDbSubnetGroup Result

    The following output properties are available:

    DbSubnetGroupDescription string
    The description for the subnet group.
    SubnetIds List<string>
    One or more subnet IDs to be assigned to the db subnet group.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    One or more tags to be assigned to the db subnet group
    DbSubnetGroupDescription string
    The description for the subnet group.
    SubnetIds []string
    One or more subnet IDs to be assigned to the db subnet group.
    Tags Tag
    One or more tags to be assigned to the db subnet group
    db_subnet_group_description string
    The description for the subnet group.
    subnet_ids list(string)
    One or more subnet IDs to be assigned to the db subnet group.
    tags list(object)
    One or more tags to be assigned to the db subnet group
    dbSubnetGroupDescription String
    The description for the subnet group.
    subnetIds List<String>
    One or more subnet IDs to be assigned to the db subnet group.
    tags List<Tag>
    One or more tags to be assigned to the db subnet group
    dbSubnetGroupDescription string
    The description for the subnet group.
    subnetIds string[]
    One or more subnet IDs to be assigned to the db subnet group.
    tags Tag[]
    One or more tags to be assigned to the db subnet group
    db_subnet_group_description str
    The description for the subnet group.
    subnet_ids Sequence[str]
    One or more subnet IDs to be assigned to the db subnet group.
    tags Sequence[root_Tag]
    One or more tags to be assigned to the db subnet group
    dbSubnetGroupDescription String
    The description for the subnet group.
    subnetIds List<String>
    One or more subnet IDs to be assigned to the db subnet group.
    tags List<Property Map>
    One or more tags to be assigned to the db subnet group

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.79.0
    published on Monday, Sep 14, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial