pulumi-aws-kotlin/com.pulumi.aws.rds.kotlin/RdsFunctions/getOrderableDbInstance

getOrderableDbInstance

suspend fun getOrderableDbInstance(argument: GetOrderableDbInstancePlainArgs): GetOrderableDbInstanceResult

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/v6/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
	})
}

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.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 = 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 preferred_engine_versions and/or preferred_instance_classes.

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/v6/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
	})
}

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.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 = 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

Return

A collection of values returned by getOrderableDbInstance.

Parameters

argument

A collection of arguments for invoking getOrderableDbInstance.

suspend fun getOrderableDbInstance(availabilityZoneGroup: String? = null, engine: String, engineLatestVersion: Boolean? = null, engineVersion: String? = null, instanceClass: String? = null, licenseModel: String? = null, preferredEngineVersions: List<String>? = null, preferredInstanceClasses: List<String>? = null, readReplicaCapable: Boolean? = null, storageType: String? = null, supportedEngineModes: List<String>? = null, supportedNetworkTypes: List<String>? = null, supportsClusters: Boolean? = null, supportsEnhancedMonitoring: Boolean? = null, supportsGlobalDatabases: Boolean? = null, supportsIamDatabaseAuthentication: Boolean? = null, supportsIops: Boolean? = null, supportsKerberosAuthentication: Boolean? = null, supportsMultiAz: Boolean? = null, supportsPerformanceInsights: Boolean? = null, supportsStorageAutoscaling: Boolean? = null, supportsStorageEncryption: Boolean? = null, vpc: Boolean? = null): GetOrderableDbInstanceResult

Return

A collection of values returned by getOrderableDbInstance.

Parameters

availabilityZoneGroup

Availability zone group.

engine

DB engine. Engine values include aurora, aurora-mysql, aurora-postgresql, docdb, mariadb, mysql, neptune, oracle-ee, oracle-se, oracle-se1, oracle-se2, postgres, sqlserver-ee, sqlserver-ex, sqlserver-se, and sqlserver-web.

engineLatestVersion

When set to true, the data source attempts to return the most recent version matching the other criteria you provide. You must use engine_latest_version with preferred_instance_classes and/or preferred_engine_versions. Using engine_latest_version will avoid multiple RDS DB Instance Classes errors. If you use engine_latest_version with preferred_instance_classes, the data source returns the latest version for the first matching instance class (instance class priority). Note: The data source uses a best-effort approach at selecting the latest version but due to the complexity of version identifiers across engines, using engine_latest_version may not return the latest version in every situation.

engineVersion

Version of the DB engine. If none is provided, the data source tries to use the AWS-defined default version that matches any other criteria.

instanceClass

DB instance class. Examples of classes are db.m3.2xlarge, db.t2.small, and db.m3.medium.

licenseModel

License model. Examples of license models are general-public-license, bring-your-own-license, and amazon-license.

preferredEngineVersions

Ordered list of preferred RDS DB instance engine versions. When engine_latest_version is not set, the data source will return the first match in this list that matches any other criteria. If the data source finds no preferred matches or multiple matches without engine_latest_version, it returns an error. CAUTION: We don't recommend using preferred_engine_versions without preferred_instance_classes since the data source returns an arbitrary instance_class based on the first one AWS returns that matches the engine version and any other criteria.

preferredInstanceClasses

Ordered list of preferred RDS DB instance classes. The data source will return the first match in this list that matches any other criteria. If the data source finds no preferred matches or multiple matches without engine_latest_version, it returns an error. If you use preferred_instance_classes without preferred_engine_versions or engine_latest_version, the data source returns an arbitrary engine_version based on the first one AWS returns matching the instance class and any other criteria.

readReplicaCapable

Whether a DB instance can have a read replica.

storageType

Storage types. Examples of storage types are standard, io1, gp2, and aurora.

supportedEngineModes

Use to limit results to engine modes such as provisioned.

supportedNetworkTypes

Use to limit results to network types IPV4 or DUAL.

supportsClusters

Whether to limit results to instances that support clusters.

supportsEnhancedMonitoring

Enable this to ensure a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

supportsGlobalDatabases

Enable this to ensure a DB instance supports Aurora global databases with a specific combination of other DB engine attributes.

supportsIamDatabaseAuthentication

Enable this to ensure a DB instance supports IAM database authentication.

supportsIops

Enable this to ensure a DB instance supports provisioned IOPS.

supportsKerberosAuthentication

Enable this to ensure a DB instance supports Kerberos Authentication.

supportsMultiAz

Whether to limit results to instances that are multi-AZ capable.

supportsPerformanceInsights

Enable this to ensure a DB instance supports Performance Insights.

supportsStorageAutoscaling

Enable this to ensure Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

supportsStorageEncryption

Enable this to ensure a DB instance supports encrypted storage.

vpc

Boolean that indicates whether to show only VPC or non-VPC offerings.

Return

A collection of values returned by getOrderableDbInstance.

Parameters

argument

Builder for com.pulumi.aws.rds.kotlin.inputs.GetOrderableDbInstancePlainArgs.

getOrderableDbInstance

Example Usage

Return

Parameters

Return

Parameters

See also

Return

Parameters

See also