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

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")
            .preferredInstanceClasses(
                "db.r6.xlarge",
                "db.m4.large",
                "db.t3.small")
            .storageType("standard")
            .build());
    }
}
Content copied to clipboard

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, engineVersion: String? = null, instanceClass: String? = null, licenseModel: String? = null, preferredEngineVersions: List<String>? = null, preferredInstanceClasses: List<String>? = null, storageType: String? = null, supportsEnhancedMonitoring: Boolean? = null, supportsGlobalDatabases: Boolean? = null, supportsIamDatabaseAuthentication: Boolean? = null, supportsIops: Boolean? = null, supportsKerberosAuthentication: 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.

engineVersion

Version of the DB engine. If none is provided, the AWS-defined default version will be used.

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

preferredInstanceClasses

Ordered list of preferred RDS 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.

storageType

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

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.

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.

See also

.

suspend fun getOrderableDbInstance(argument: suspend GetOrderableDbInstancePlainArgsBuilder.() -> Unit): GetOrderableDbInstanceResult

Return

A collection of values returned by getOrderableDbInstance.

Parameters

argument

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

See also

.