getOrderableDbInstance function

Future<GetOrderableDbInstanceResult> getOrderableDbInstance(
  1. GetOrderableDbInstanceArgs args, {
  2. InvokeOptions? options,
})

Information about DocumentDB orderable DB instances.

Example Usage

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

const test = aws.docdb.getOrderableDbInstance({
    engine: "docdb",
    engineVersion: "3.6.0",
    licenseModel: "na",
    preferredInstanceClasses: [
        "db.r5.large",
        "db.r4.large",
        "db.t3.medium",
    ],
});
import pulumi
import pulumi_aws as aws

test = aws.docdb.get_orderable_db_instance(engine="docdb",
    engine_version="3.6.0",
    license_model="na",
    preferred_instance_classes=[
        "db.r5.large",
        "db.r4.large",
        "db.t3.medium",
    ])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = Aws.DocDB.GetOrderableDbInstance.Invoke(new()
    {
        Engine = "docdb",
        EngineVersion = "3.6.0",
        LicenseModel = "na",
        PreferredInstanceClasses = new[]
        {
            "db.r5.large",
            "db.r4.large",
            "db.t3.medium",
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := docdb.GetOrderableDbInstance(ctx, &docdb.GetOrderableDbInstanceArgs{
			Engine:        pulumi.StringRef("docdb"),
			EngineVersion: pulumi.StringRef("3.6.0"),
			LicenseModel:  pulumi.StringRef("na"),
			PreferredInstanceClasses: []string{
				"db.r5.large",
				"db.r4.large",
				"db.t3.medium",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_docdb_getorderabledbinstance" "test" {
  engine                     = "docdb"
  engine_version             = "3.6.0"
  license_model              = "na"
  preferred_instance_classes = ["db.r5.large", "db.r4.large", "db.t3.medium"]
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.docdb.DocdbFunctions;
import com.pulumi.aws.docdb.inputs.GetOrderableDbInstanceArgs;
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 test = DocdbFunctions.getOrderableDbInstance(GetOrderableDbInstanceArgs.builder()
            .engine("docdb")
            .engineVersion("3.6.0")
            .licenseModel("na")
            .preferredInstanceClasses(
                "db.r5.large",
                "db.r4.large",
                "db.t3.medium")
            .build());

    }
}
variables:
  test:
    fn::invoke:
      function: aws:docdb:getOrderableDbInstance
      arguments:
        engine: docdb
        engineVersion: 3.6.0
        licenseModel: na
        preferredInstanceClasses:
          - db.r5.large
          - db.r4.large
          - db.t3.medium

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

Implementation

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