Skip to content

Data Source: awsRdsOrderableDbInstance

Information about RDS orderable DB instances and valid parameter combinations.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.dataAwsRdsOrderableDbInstance.DataAwsRdsOrderableDbInstance(
  this,
  "test",
  {
    engine: "mysql",
    engineVersion: "5.7.22",
    licenseModel: "general-public-license",
    preferredInstanceClasses: ["db.r6.xlarge", "db.m4.large", "db.t3.small"],
    storageType: "standard",
  }
);

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

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.dataAwsRdsOrderableDbInstance.DataAwsRdsOrderableDbInstance(
  this,
  "test",
  {
    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"],
  }
);

Argument Reference

The following arguments are supported:

  • availabilityZoneGroup - (Optional) Availability zone group.
  • engine - (Required) DB engine. Engine values include aurora, auroraMysql, auroraPostgresql, docdb, mariadb, mysql, neptune, oracleEe, oracleSe, oracleSe1, oracleSe2, postgres, sqlserverEe, sqlserverEx, sqlserverSe, and sqlserverWeb.
  • engineVersion - (Optional) Version of the DB engine. If none is provided, the AWS-defined default version will be used.
  • instanceClass - (Optional) DB instance class. Examples of classes are dbM32Xlarge, dbT2Small, and dbM3Medium.
  • licenseModel - (Optional) License model. Examples of license models are generalPublicLicense, bringYourOwnLicense, and amazonLicense.
  • preferredInstanceClasses - (Optional) 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.
  • preferredEngineVersions - (Optional) 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.
  • storageType - (Optional) Storage types. Examples of storage types are standard, io1, gp2, and aurora.
  • supportsEnhancedMonitoring - (Optional) Enable this to ensure a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
  • supportsGlobalDatabases - (Optional) Enable this to ensure a DB instance supports Aurora global databases with a specific combination of other DB engine attributes.
  • supportsIamDatabaseAuthentication - (Optional) Enable this to ensure a DB instance supports IAM database authentication.
  • supportsIops - (Optional) Enable this to ensure a DB instance supports provisioned IOPS.
  • supportsKerberosAuthentication - (Optional) Enable this to ensure a DB instance supports Kerberos Authentication.
  • supportsPerformanceInsights - (Optional) Enable this to ensure a DB instance supports Performance Insights.
  • supportsStorageAutoscaling - (Optional) Enable this to ensure Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
  • supportsStorageEncryption - (Optional) Enable this to ensure a DB instance supports encrypted storage.
  • vpc - (Optional) Boolean that indicates whether to show only VPC or non-VPC offerings.

Attribute Reference

In addition to all arguments above, the following attributes are exported:

  • availabilityZones - Availability zones where the instance is available.
  • maxIopsPerDbInstance - Maximum total provisioned IOPS for a DB instance.
  • maxIopsPerGib - Maximum provisioned IOPS per GiB for a DB instance.
  • maxStorageSize - Maximum storage size for a DB instance.
  • minIopsPerDbInstance - Minimum total provisioned IOPS for a DB instance.
  • minIopsPerGib - Minimum provisioned IOPS per GiB for a DB instance.
  • minStorageSize - Minimum storage size for a DB instance.
  • multiAzCapable - Whether a DB instance is Multi-AZ capable.
  • outpostCapable - Whether a DB instance supports RDS on Outposts.
  • readReplicaCapable - Whether a DB instance can have a read replica.
  • supportedEngineModes - A list of the supported DB engine modes.
  • supportedNetworkTypes - The network types supported by the DB instance (ipv4 or dual).