aws.docdb.getOrderableDbInstance

Explore with Pulumi AI

AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi

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",
    ])

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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
	})
}

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 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.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) {
        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

Using getOrderableDbInstance

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 getOrderableDbInstance(args: GetOrderableDbInstanceArgs, opts?: InvokeOptions): Promise<GetOrderableDbInstanceResult>
function getOrderableDbInstanceOutput(args: GetOrderableDbInstanceOutputArgs, opts?: InvokeOptions): Output<GetOrderableDbInstanceResult>

def get_orderable_db_instance(engine: Optional[str] = None,
                              engine_version: Optional[str] = None,
                              instance_class: Optional[str] = None,
                              license_model: Optional[str] = None,
                              preferred_instance_classes: Optional[Sequence[str]] = None,
                              vpc: Optional[bool] = None,
                              opts: Optional[InvokeOptions] = None) -> GetOrderableDbInstanceResult
def get_orderable_db_instance_output(engine: Optional[pulumi.Input[str]] = None,
                              engine_version: Optional[pulumi.Input[str]] = None,
                              instance_class: Optional[pulumi.Input[str]] = None,
                              license_model: Optional[pulumi.Input[str]] = None,
                              preferred_instance_classes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                              vpc: Optional[pulumi.Input[bool]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetOrderableDbInstanceResult]

func GetOrderableDbInstance(ctx *Context, args *GetOrderableDbInstanceArgs, opts ...InvokeOption) (*GetOrderableDbInstanceResult, error)
func GetOrderableDbInstanceOutput(ctx *Context, args *GetOrderableDbInstanceOutputArgs, opts ...InvokeOption) GetOrderableDbInstanceResultOutput

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

public static class GetOrderableDbInstance 
{
    public static Task<GetOrderableDbInstanceResult> InvokeAsync(GetOrderableDbInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetOrderableDbInstanceResult> Invoke(GetOrderableDbInstanceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOrderableDbInstanceResult> getOrderableDbInstance(GetOrderableDbInstanceArgs args, InvokeOptions options)
public static Output<GetOrderableDbInstanceResult> getOrderableDbInstance(GetOrderableDbInstanceArgs args, InvokeOptions options)

fn::invoke:
  function: aws:docdb/getOrderableDbInstance:getOrderableDbInstance
  arguments:
    # arguments dictionary

The following arguments are supported:

Engine string: DB engine. Default: docdb
EngineVersion string: Version of the DB engine.
InstanceClass string: DB instance class. Examples of classes are db.r5.12xlarge, db.r5.24xlarge, db.r5.2xlarge, db.r5.4xlarge, db.r5.large, db.r5.xlarge, and db.t3.medium. (Conflicts with preferred_instance_classes.)
LicenseModel string: License model. Default: na
PreferredInstanceClasses List<string>: Ordered list of preferred DocumentDB DB instance classes. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. (Conflicts with instance_class.)
Vpc bool: Enable to show only VPC.

Engine string: DB engine. Default: docdb
EngineVersion string: Version of the DB engine.
InstanceClass string: DB instance class. Examples of classes are db.r5.12xlarge, db.r5.24xlarge, db.r5.2xlarge, db.r5.4xlarge, db.r5.large, db.r5.xlarge, and db.t3.medium. (Conflicts with preferred_instance_classes.)
LicenseModel string: License model. Default: na
PreferredInstanceClasses []string: Ordered list of preferred DocumentDB DB instance classes. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. (Conflicts with instance_class.)
Vpc bool: Enable to show only VPC.

engine String: DB engine. Default: docdb
engineVersion String: Version of the DB engine.
instanceClass String: DB instance class. Examples of classes are db.r5.12xlarge, db.r5.24xlarge, db.r5.2xlarge, db.r5.4xlarge, db.r5.large, db.r5.xlarge, and db.t3.medium. (Conflicts with preferred_instance_classes.)
licenseModel String: License model. Default: na
preferredInstanceClasses List<String>: Ordered list of preferred DocumentDB DB instance classes. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. (Conflicts with instance_class.)
vpc Boolean: Enable to show only VPC.

engine string: DB engine. Default: docdb
engineVersion string: Version of the DB engine.
instanceClass string: DB instance class. Examples of classes are db.r5.12xlarge, db.r5.24xlarge, db.r5.2xlarge, db.r5.4xlarge, db.r5.large, db.r5.xlarge, and db.t3.medium. (Conflicts with preferred_instance_classes.)
licenseModel string: License model. Default: na
preferredInstanceClasses string[]: Ordered list of preferred DocumentDB DB instance classes. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. (Conflicts with instance_class.)
vpc boolean: Enable to show only VPC.

engine str: DB engine. Default: docdb
engine_version str: Version of the DB engine.
instance_class str: DB instance class. Examples of classes are db.r5.12xlarge, db.r5.24xlarge, db.r5.2xlarge, db.r5.4xlarge, db.r5.large, db.r5.xlarge, and db.t3.medium. (Conflicts with preferred_instance_classes.)
license_model str: License model. Default: na
preferred_instance_classes Sequence[str]: Ordered list of preferred DocumentDB DB instance classes. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. (Conflicts with instance_class.)
vpc bool: Enable to show only VPC.

engine String: DB engine. Default: docdb
engineVersion String: Version of the DB engine.
instanceClass String: DB instance class. Examples of classes are db.r5.12xlarge, db.r5.24xlarge, db.r5.2xlarge, db.r5.4xlarge, db.r5.large, db.r5.xlarge, and db.t3.medium. (Conflicts with preferred_instance_classes.)
licenseModel String: License model. Default: na
preferredInstanceClasses List<String>: Ordered list of preferred DocumentDB DB instance classes. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. (Conflicts with instance_class.)
vpc Boolean: Enable to show only VPC.

getOrderableDbInstance Result

The following output properties are available:

AvailabilityZones List<string>: Availability zones where the instance is available.
EngineVersion string
Id string: The provider-assigned unique ID for this managed resource.
InstanceClass string
Vpc bool
Engine string
LicenseModel string
PreferredInstanceClasses List<string>

AvailabilityZones []string: Availability zones where the instance is available.
EngineVersion string
Id string: The provider-assigned unique ID for this managed resource.
InstanceClass string
Vpc bool
Engine string
LicenseModel string
PreferredInstanceClasses []string

availabilityZones List<String>: Availability zones where the instance is available.
engineVersion String
id String: The provider-assigned unique ID for this managed resource.
instanceClass String
vpc Boolean
engine String
licenseModel String
preferredInstanceClasses List<String>

availabilityZones string[]: Availability zones where the instance is available.
engineVersion string
id string: The provider-assigned unique ID for this managed resource.
instanceClass string
vpc boolean
engine string
licenseModel string
preferredInstanceClasses string[]

availability_zones Sequence[str]: Availability zones where the instance is available.
engine_version str
id str: The provider-assigned unique ID for this managed resource.
instance_class str
vpc bool
engine str
license_model str
preferred_instance_classes Sequence[str]

availabilityZones List<String>: Availability zones where the instance is available.
engineVersion String
id String: The provider-assigned unique ID for this managed resource.
instanceClass String
vpc Boolean
engine String
licenseModel String
preferredInstanceClasses List<String>

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi

pulumi/pulumi-aws

aws.docdb.getOrderableDbInstance

On this page

On this page

Example Usage

Using getOrderableDbInstance

getOrderableDbInstance Result

Package Details

On this page

On this page