Skip to content

Data Source: awsRdsEngineVersion

Information about an RDS engine version.

Example Usage

Basic 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.dataAwsRdsEngineVersion.DataAwsRdsEngineVersion(this, "test", {
  engine: "mysql",
  preferredVersions: ["8.0.27", "8.0.26"],
});

With filter

/*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.dataAwsRdsEngineVersion.DataAwsRdsEngineVersion(this, "test", {
  engine: "aurora-postgresql",
  filter: [
    {
      name: "engine-mode",
      values: ["serverless"],
    },
  ],
  includeAll: true,
  version: "10.14",
});

Argument Reference

The following arguments are supported:

  • engine - (Required) DB engine. Engine values include aurora, auroraMysql, auroraPostgresql, docdb, mariadb, mysql, neptune, oracleEe, oracleSe, oracleSe1, oracleSe2, postgres, sqlserverEe, sqlserverEx, sqlserverSe, and sqlserverWeb.
  • defaultOnly - (Optional) When set to true, the default version for the specified engine or combination of engine and major version will be returned. Can be used to limit responses to a single version when they would otherwise fail for returning multiple versions.
  • filter - (Optional) One or more name/value pairs to filter off of. There are several valid keys; for a full reference, check out describe-db-engine-versions in the AWS CLI reference.
  • includeAll - (Optional) When set to true, the specified version or member of preferredVersions will be returned even if it is deprecated. Otherwise, only available versions will be returned.
  • parameterGroupFamily - (Optional) Name of a specific DB parameter group family. Examples of parameter group families are mysql80, mariadb104, and postgres12.
  • preferredVersions - (Optional) Ordered list of preferred 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. If both the version and preferredVersions arguments are not configured, the data source will return the default version for the engine.
  • version - (Optional) Version of the DB engine. For example, 5722, 10134, and 123. If both the version and preferredVersions arguments are not configured, the data source will return the default version for the engine.

Attribute Reference

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

  • defaultCharacterSet - The default character set for new instances of this engine version.
  • engineDescription - Description of the database engine.
  • exportableLogTypes - Set of log types that the database engine has available for export to CloudWatch Logs.
  • status - Status of the DB engine version, either available or deprecated.
  • supportedCharacterSets - Set of the character sets supported by this engine.
  • supportedFeatureNames - Set of features supported by the DB engine.
  • supportedModes - Set of the supported DB engine modes.
  • supportedTimezones - Set of the time zones supported by this engine.
  • supportsGlobalDatabases - Indicates whether you can use Aurora global databases with a specific DB engine version.
  • supportsLogExportsToCloudwatch - Indicates whether the engine version supports exporting the log types specified by exportableLogTypes to CloudWatch Logs.
  • supportsParallelQuery - Indicates whether you can use Aurora parallel query with a specific DB engine version.
  • supportsReadReplica - Indicates whether the database engine version supports read replicas.
  • validUpgradeTargets - Set of engine versions that this database engine version can be upgraded to.
  • versionDescription - Description of the database engine version.