getOrderableDbInstance function

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

Information about RDS orderable DB instances and valid parameter combinations.

Example Usage

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

const test = aws.rds.getOrderableDbInstance({
    engine: "mysql",
    engineVersion: "5.7.22",
    licenseModel: "general-public-license",
    storageType: "standard",
    preferredInstanceClasses: [
        "db.r6.xlarge",
        "db.m4.large",
        "db.t3.small",
    ],
});
import pulumi
import pulumi_aws as aws

test = aws.rds.get_orderable_db_instance(engine="mysql",
    engine_version="5.7.22",
    license_model="general-public-license",
    storage_type="standard",
    preferred_instance_classes=[
        "db.r6.xlarge",
        "db.m4.large",
        "db.t3.small",
    ])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = Aws.Rds.GetOrderableDbInstance.Invoke(new()
    {
        Engine = "mysql",
        EngineVersion = "5.7.22",
        LicenseModel = "general-public-license",
        StorageType = "standard",
        PreferredInstanceClasses = new[]
        {
            "db.r6.xlarge",
            "db.m4.large",
            "db.t3.small",
        },
    });

});
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.GetOrderableDbInstance(ctx, &rds.GetOrderableDbInstanceArgs{
			Engine:        "mysql",
			EngineVersion: pulumi.StringRef("5.7.22"),
			LicenseModel:  pulumi.StringRef("general-public-license"),
			StorageType:   pulumi.StringRef("standard"),
			PreferredInstanceClasses: []string{
				"db.r6.xlarge",
				"db.m4.large",
				"db.t3.small",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_rds_getorderabledbinstance" "test" {
  engine                     = "mysql"
  engine_version             = "5.7.22"
  license_model              = "general-public-license"
  storage_type               = "standard"
  preferred_instance_classes = ["db.r6.xlarge", "db.m4.large", "db.t3.small"]
}
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.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 = RdsFunctions.getOrderableDbInstance(GetOrderableDbInstanceArgs.builder()
            .engine("mysql")
            .engineVersion("5.7.22")
            .licenseModel("general-public-license")
            .storageType("standard")
            .preferredInstanceClasses(
                "db.r6.xlarge",
                "db.m4.large",
                "db.t3.small")
            .build());

    }
}
variables:
  test:
    fn::invoke:
      function: aws:rds:getOrderableDbInstance
      arguments:
        engine: mysql
        engineVersion: 5.7.22
        licenseModel: general-public-license
        storageType: standard
        preferredInstanceClasses:
          - db.r6.xlarge
          - db.m4.large
          - db.t3.small

Valid parameter combinations can also be found with preferredEngineVersions and/or preferredInstanceClasses.

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

const test = aws.rds.getOrderableDbInstance({
    engine: "mysql",
    licenseModel: "general-public-license",
    preferredEngineVersions: [
        "5.6.35",
        "5.6.41",
        "5.6.44",
    ],
    preferredInstanceClasses: [
        "db.t2.small",
        "db.t3.medium",
        "db.t3.large",
    ],
});
import pulumi
import pulumi_aws as aws

test = aws.rds.get_orderable_db_instance(engine="mysql",
    license_model="general-public-license",
    preferred_engine_versions=[
        "5.6.35",
        "5.6.41",
        "5.6.44",
    ],
    preferred_instance_classes=[
        "db.t2.small",
        "db.t3.medium",
        "db.t3.large",
    ])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = Aws.Rds.GetOrderableDbInstance.Invoke(new()
    {
        Engine = "mysql",
        LicenseModel = "general-public-license",
        PreferredEngineVersions = new[]
        {
            "5.6.35",
            "5.6.41",
            "5.6.44",
        },
        PreferredInstanceClasses = new[]
        {
            "db.t2.small",
            "db.t3.medium",
            "db.t3.large",
        },
    });

});
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.GetOrderableDbInstance(ctx, &rds.GetOrderableDbInstanceArgs{
			Engine:       "mysql",
			LicenseModel: pulumi.StringRef("general-public-license"),
			PreferredEngineVersions: []string{
				"5.6.35",
				"5.6.41",
				"5.6.44",
			},
			PreferredInstanceClasses: []string{
				"db.t2.small",
				"db.t3.medium",
				"db.t3.large",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_rds_getorderabledbinstance" "test" {
  engine                     = "mysql"
  license_model              = "general-public-license"
  preferred_engine_versions  = ["5.6.35", "5.6.41", "5.6.44"]
  preferred_instance_classes = ["db.t2.small", "db.t3.medium", "db.t3.large"]
}
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.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 = RdsFunctions.getOrderableDbInstance(GetOrderableDbInstanceArgs.builder()
            .engine("mysql")
            .licenseModel("general-public-license")
            .preferredEngineVersions(
                "5.6.35",
                "5.6.41",
                "5.6.44")
            .preferredInstanceClasses(
                "db.t2.small",
                "db.t3.medium",
                "db.t3.large")
            .build());

    }
}
variables:
  test:
    fn::invoke:
      function: aws:rds:getOrderableDbInstance
      arguments:
        engine: mysql
        licenseModel: general-public-license
        preferredEngineVersions:
          - 5.6.35
          - 5.6.41
          - 5.6.44
        preferredInstanceClasses:
          - db.t2.small
          - db.t3.medium
          - db.t3.large

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:rds/getOrderableDbInstance:getOrderableDbInstance',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetOrderableDbInstanceResult.fromMap(result);
}