getInstance function

Future<GetInstanceResult> getInstance(
  1. GetInstanceArgs args, {
  2. InvokeOptions? options,
})

Use this data source to get information about an RDS instance

Example Usage

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

const database = aws.rds.getInstance({
    dbInstanceIdentifier: "my-test-database",
});
import pulumi
import pulumi_aws as aws

database = aws.rds.get_instance(db_instance_identifier="my-test-database")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var database = Aws.Rds.GetInstance.Invoke(new()
    {
        DbInstanceIdentifier = "my-test-database",
    });

});
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.LookupInstance(ctx, &rds.LookupInstanceArgs{
			DbInstanceIdentifier: pulumi.StringRef("my-test-database"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_rds_getinstance" "database" {
  db_instance_identifier = "my-test-database"
}
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.GetInstanceArgs;
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.getInstance(GetInstanceArgs.builder()
            .dbInstanceIdentifier("my-test-database")
            .build());

    }
}
variables:
  database:
    fn::invoke:
      function: aws:rds:getInstance
      arguments:
        dbInstanceIdentifier: my-test-database

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

Implementation

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