getSubnetGroup function

Future<GetSubnetGroupResult> getSubnetGroup(
  1. GetSubnetGroupArgs args, {
  2. InvokeOptions? options,
})

Use this data source to get information about an RDS subnet group.

Example Usage

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

const database = aws.rds.getSubnetGroup({
    name: "my-test-database-subnet-group",
});
import pulumi
import pulumi_aws as aws

database = aws.rds.get_subnet_group(name="my-test-database-subnet-group")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var database = Aws.Rds.GetSubnetGroup.Invoke(new()
    {
        Name = "my-test-database-subnet-group",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds.LookupSubnetGroup(ctx, &rds.LookupSubnetGroupArgs{
			Name: "my-test-database-subnet-group",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_rds_getsubnetgroup" "database" {
  name = "my-test-database-subnet-group"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.RdsFunctions;
import com.pulumi.aws.rds.inputs.GetSubnetGroupArgs;
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) {
        final var database = RdsFunctions.getSubnetGroup(GetSubnetGroupArgs.builder()
            .name("my-test-database-subnet-group")
            .build());

    }
}
variables:
  database:
    fn::invoke:
      function: aws:rds:getSubnetGroup
      arguments:
        name: my-test-database-subnet-group

args Arguments passed to this invoke. Arguments for getSubnetGroup. options Invoke options controlling this call.

Implementation

Future<GetSubnetGroupResult> getSubnetGroup(
  GetSubnetGroupArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:rds/getSubnetGroup:getSubnetGroup',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetSubnetGroupResult.fromMap(result);
}