Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
published on Tuesday, Mar 10, 2026 by Pulumi
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
published on Tuesday, Mar 10, 2026 by Pulumi
Information about an RDS engine version.
Example Usage
Basic Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = Aws.Rds.GetEngineVersion.Invoke(new()
{
Engine = "mysql",
PreferredVersions = new[]
{
"8.0.27",
"8.0.26",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/rds"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rds.GetEngineVersion(ctx, &rds.GetEngineVersionArgs{
Engine: "mysql",
PreferredVersions: []string{
"8.0.27",
"8.0.26",
},
}, 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.GetEngineVersionArgs;
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.getEngineVersion(GetEngineVersionArgs.builder()
.engine("mysql")
.preferredVersions(
"8.0.27",
"8.0.26")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = aws.rds.getEngineVersion({
engine: "mysql",
preferredVersions: [
"8.0.27",
"8.0.26",
],
});
import pulumi
import pulumi_aws as aws
test = aws.rds.get_engine_version(engine="mysql",
preferred_versions=[
"8.0.27",
"8.0.26",
])
variables:
test:
fn::invoke:
Function: aws:rds:getEngineVersion
Arguments:
engine: mysql
preferredVersions:
- 8.0.27
- 8.0.26
With filter
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = Aws.Rds.GetEngineVersion.Invoke(new()
{
Engine = "aurora-postgresql",
Filters = new[]
{
new Aws.Rds.Inputs.GetEngineVersionFilterInputArgs
{
Name = "engine-mode",
Values = new[]
{
"serverless",
},
},
},
IncludeAll = true,
Version = "10.14",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/rds"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rds.GetEngineVersion(ctx, &rds.GetEngineVersionArgs{
Engine: "aurora-postgresql",
Filters: []rds.GetEngineVersionFilter{
{
Name: "engine-mode",
Values: []string{
"serverless",
},
},
},
IncludeAll: pulumi.BoolRef(true),
Version: pulumi.StringRef("10.14"),
}, 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.GetEngineVersionArgs;
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.getEngineVersion(GetEngineVersionArgs.builder()
.engine("aurora-postgresql")
.filters(GetEngineVersionFilterArgs.builder()
.name("engine-mode")
.values("serverless")
.build())
.includeAll(true)
.version("10.14")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = aws.rds.getEngineVersion({
engine: "aurora-postgresql",
filters: [{
name: "engine-mode",
values: ["serverless"],
}],
includeAll: true,
version: "10.14",
});
import pulumi
import pulumi_aws as aws
test = aws.rds.get_engine_version(engine="aurora-postgresql",
filters=[aws.rds.GetEngineVersionFilterArgs(
name="engine-mode",
values=["serverless"],
)],
include_all=True,
version="10.14")
variables:
test:
fn::invoke:
Function: aws:rds:getEngineVersion
Arguments:
engine: aurora-postgresql
filters:
- name: engine-mode
values:
- serverless
includeAll: true
version: '10.14'
Using getEngineVersion
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getEngineVersion(args: GetEngineVersionArgs, opts?: InvokeOptions): Promise<GetEngineVersionResult>
function getEngineVersionOutput(args: GetEngineVersionOutputArgs, opts?: InvokeOptions): Output<GetEngineVersionResult>def get_engine_version(default_only: Optional[bool] = None,
engine: Optional[str] = None,
filters: Optional[Sequence[GetEngineVersionFilter]] = None,
include_all: Optional[bool] = None,
parameter_group_family: Optional[str] = None,
preferred_versions: Optional[Sequence[str]] = None,
version: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetEngineVersionResult
def get_engine_version_output(default_only: Optional[pulumi.Input[bool]] = None,
engine: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetEngineVersionFilterArgs]]]] = None,
include_all: Optional[pulumi.Input[bool]] = None,
parameter_group_family: Optional[pulumi.Input[str]] = None,
preferred_versions: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
version: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetEngineVersionResult]func GetEngineVersion(ctx *Context, args *GetEngineVersionArgs, opts ...InvokeOption) (*GetEngineVersionResult, error)
func GetEngineVersionOutput(ctx *Context, args *GetEngineVersionOutputArgs, opts ...InvokeOption) GetEngineVersionResultOutput> Note: This function is named GetEngineVersion in the Go SDK.
public static class GetEngineVersion
{
public static Task<GetEngineVersionResult> InvokeAsync(GetEngineVersionArgs args, InvokeOptions? opts = null)
public static Output<GetEngineVersionResult> Invoke(GetEngineVersionInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetEngineVersionResult> getEngineVersion(GetEngineVersionArgs args, InvokeOptions options)
public static Output<GetEngineVersionResult> getEngineVersion(GetEngineVersionArgs args, InvokeOptions options)
fn::invoke:
function: aws:rds/getEngineVersion:getEngineVersion
arguments:
# arguments dictionaryThe following arguments are supported:
- Engine string
- 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, andsqlserver-web. - Default
Only bool - When set to
true, the default version for the specifiedengineor combination ofengineand majorversionwill be returned. Can be used to limit responses to a single version when they would otherwise fail for returning multiple versions. - Filters
List<Get
Engine Version Filter> - 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.
- Include
All bool - When set to
true, the specifiedversionor member ofpreferred_versionswill be returned even if it isdeprecated. Otherwise, onlyavailableversions will be returned. - Parameter
Group stringFamily - Name of a specific DB parameter group family. Examples of parameter group families are
mysql8.0,mariadb10.4, andpostgres12. - Preferred
Versions List<string> - 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
versionandpreferred_versionsarguments are not configured, the data source will return the default version for the engine. - Version string
- Version of the DB engine. For example,
5.7.22,10.1.34, and12.3. If both theversionandpreferred_versionsarguments are not configured, the data source will return the default version for the engine.
- Engine string
- 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, andsqlserver-web. - Default
Only bool - When set to
true, the default version for the specifiedengineor combination ofengineand majorversionwill be returned. Can be used to limit responses to a single version when they would otherwise fail for returning multiple versions. - Filters
[]Get
Engine Version Filter - 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.
- Include
All bool - When set to
true, the specifiedversionor member ofpreferred_versionswill be returned even if it isdeprecated. Otherwise, onlyavailableversions will be returned. - Parameter
Group stringFamily - Name of a specific DB parameter group family. Examples of parameter group families are
mysql8.0,mariadb10.4, andpostgres12. - Preferred
Versions []string - 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
versionandpreferred_versionsarguments are not configured, the data source will return the default version for the engine. - Version string
- Version of the DB engine. For example,
5.7.22,10.1.34, and12.3. If both theversionandpreferred_versionsarguments are not configured, the data source will return the default version for the engine.
- engine String
- 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, andsqlserver-web. - default
Only Boolean - When set to
true, the default version for the specifiedengineor combination ofengineand majorversionwill be returned. Can be used to limit responses to a single version when they would otherwise fail for returning multiple versions. - filters
List<Get
Engine Version Filter> - 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.
- include
All Boolean - When set to
true, the specifiedversionor member ofpreferred_versionswill be returned even if it isdeprecated. Otherwise, onlyavailableversions will be returned. - parameter
Group StringFamily - Name of a specific DB parameter group family. Examples of parameter group families are
mysql8.0,mariadb10.4, andpostgres12. - preferred
Versions List<String> - 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
versionandpreferred_versionsarguments are not configured, the data source will return the default version for the engine. - version String
- Version of the DB engine. For example,
5.7.22,10.1.34, and12.3. If both theversionandpreferred_versionsarguments are not configured, the data source will return the default version for the engine.
- engine string
- 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, andsqlserver-web. - default
Only boolean - When set to
true, the default version for the specifiedengineor combination ofengineand majorversionwill be returned. Can be used to limit responses to a single version when they would otherwise fail for returning multiple versions. - filters
Get
Engine Version Filter[] - 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.
- include
All boolean - When set to
true, the specifiedversionor member ofpreferred_versionswill be returned even if it isdeprecated. Otherwise, onlyavailableversions will be returned. - parameter
Group stringFamily - Name of a specific DB parameter group family. Examples of parameter group families are
mysql8.0,mariadb10.4, andpostgres12. - preferred
Versions string[] - 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
versionandpreferred_versionsarguments are not configured, the data source will return the default version for the engine. - version string
- Version of the DB engine. For example,
5.7.22,10.1.34, and12.3. If both theversionandpreferred_versionsarguments are not configured, the data source will return the default version for the engine.
- engine str
- 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, andsqlserver-web. - default_
only bool - When set to
true, the default version for the specifiedengineor combination ofengineand majorversionwill be returned. Can be used to limit responses to a single version when they would otherwise fail for returning multiple versions. - filters
Sequence[Get
Engine Version Filter] - 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.
- include_
all bool - When set to
true, the specifiedversionor member ofpreferred_versionswill be returned even if it isdeprecated. Otherwise, onlyavailableversions will be returned. - parameter_
group_ strfamily - Name of a specific DB parameter group family. Examples of parameter group families are
mysql8.0,mariadb10.4, andpostgres12. - preferred_
versions Sequence[str] - 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
versionandpreferred_versionsarguments are not configured, the data source will return the default version for the engine. - version str
- Version of the DB engine. For example,
5.7.22,10.1.34, and12.3. If both theversionandpreferred_versionsarguments are not configured, the data source will return the default version for the engine.
- engine String
- 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, andsqlserver-web. - default
Only Boolean - When set to
true, the default version for the specifiedengineor combination ofengineand majorversionwill be returned. Can be used to limit responses to a single version when they would otherwise fail for returning multiple versions. - filters List<Property Map>
- 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.
- include
All Boolean - When set to
true, the specifiedversionor member ofpreferred_versionswill be returned even if it isdeprecated. Otherwise, onlyavailableversions will be returned. - parameter
Group StringFamily - Name of a specific DB parameter group family. Examples of parameter group families are
mysql8.0,mariadb10.4, andpostgres12. - preferred
Versions List<String> - 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
versionandpreferred_versionsarguments are not configured, the data source will return the default version for the engine. - version String
- Version of the DB engine. For example,
5.7.22,10.1.34, and12.3. If both theversionandpreferred_versionsarguments are not configured, the data source will return the default version for the engine.
getEngineVersion Result
The following output properties are available:
- Default
Character stringSet - The default character set for new instances of this engine version.
- Engine string
- Engine
Description string - Description of the database engine.
- Exportable
Log List<string>Types - Set of log types that the database engine has available for export to CloudWatch Logs.
- Id string
- The provider-assigned unique ID for this managed resource.
- Parameter
Group stringFamily - Status string
- Status of the DB engine version, either available or deprecated.
- Supported
Character List<string>Sets - Set of the character sets supported by this engine.
- Supported
Feature List<string>Names - Set of features supported by the DB engine.
- Supported
Modes List<string> - Set of the supported DB engine modes.
- Supported
Timezones List<string> - Set of the time zones supported by this engine.
- Supports
Global boolDatabases - Indicates whether you can use Aurora global databases with a specific DB engine version.
- Supports
Log boolExports To Cloudwatch - Indicates whether the engine version supports exporting the log types specified by
exportable_log_typesto CloudWatch Logs. - Supports
Parallel boolQuery - Indicates whether you can use Aurora parallel query with a specific DB engine version.
- Supports
Read boolReplica - Indicates whether the database engine version supports read replicas.
- Valid
Upgrade List<string>Targets - Set of engine versions that this database engine version can be upgraded to.
- Version string
- Version
Description string - Description of the database engine version.
- Default
Only bool - Filters
List<Get
Engine Version Filter> - Include
All bool - Preferred
Versions List<string>
- Default
Character stringSet - The default character set for new instances of this engine version.
- Engine string
- Engine
Description string - Description of the database engine.
- Exportable
Log []stringTypes - Set of log types that the database engine has available for export to CloudWatch Logs.
- Id string
- The provider-assigned unique ID for this managed resource.
- Parameter
Group stringFamily - Status string
- Status of the DB engine version, either available or deprecated.
- Supported
Character []stringSets - Set of the character sets supported by this engine.
- Supported
Feature []stringNames - Set of features supported by the DB engine.
- Supported
Modes []string - Set of the supported DB engine modes.
- Supported
Timezones []string - Set of the time zones supported by this engine.
- Supports
Global boolDatabases - Indicates whether you can use Aurora global databases with a specific DB engine version.
- Supports
Log boolExports To Cloudwatch - Indicates whether the engine version supports exporting the log types specified by
exportable_log_typesto CloudWatch Logs. - Supports
Parallel boolQuery - Indicates whether you can use Aurora parallel query with a specific DB engine version.
- Supports
Read boolReplica - Indicates whether the database engine version supports read replicas.
- Valid
Upgrade []stringTargets - Set of engine versions that this database engine version can be upgraded to.
- Version string
- Version
Description string - Description of the database engine version.
- Default
Only bool - Filters
[]Get
Engine Version Filter - Include
All bool - Preferred
Versions []string
- default
Character StringSet - The default character set for new instances of this engine version.
- engine String
- engine
Description String - Description of the database engine.
- exportable
Log List<String>Types - Set of log types that the database engine has available for export to CloudWatch Logs.
- id String
- The provider-assigned unique ID for this managed resource.
- parameter
Group StringFamily - status String
- Status of the DB engine version, either available or deprecated.
- supported
Character List<String>Sets - Set of the character sets supported by this engine.
- supported
Feature List<String>Names - Set of features supported by the DB engine.
- supported
Modes List<String> - Set of the supported DB engine modes.
- supported
Timezones List<String> - Set of the time zones supported by this engine.
- supports
Global BooleanDatabases - Indicates whether you can use Aurora global databases with a specific DB engine version.
- supports
Log BooleanExports To Cloudwatch - Indicates whether the engine version supports exporting the log types specified by
exportable_log_typesto CloudWatch Logs. - supports
Parallel BooleanQuery - Indicates whether you can use Aurora parallel query with a specific DB engine version.
- supports
Read BooleanReplica - Indicates whether the database engine version supports read replicas.
- valid
Upgrade List<String>Targets - Set of engine versions that this database engine version can be upgraded to.
- version String
- version
Description String - Description of the database engine version.
- default
Only Boolean - filters
List<Get
Engine Version Filter> - include
All Boolean - preferred
Versions List<String>
- default
Character stringSet - The default character set for new instances of this engine version.
- engine string
- engine
Description string - Description of the database engine.
- exportable
Log string[]Types - Set of log types that the database engine has available for export to CloudWatch Logs.
- id string
- The provider-assigned unique ID for this managed resource.
- parameter
Group stringFamily - status string
- Status of the DB engine version, either available or deprecated.
- supported
Character string[]Sets - Set of the character sets supported by this engine.
- supported
Feature string[]Names - Set of features supported by the DB engine.
- supported
Modes string[] - Set of the supported DB engine modes.
- supported
Timezones string[] - Set of the time zones supported by this engine.
- supports
Global booleanDatabases - Indicates whether you can use Aurora global databases with a specific DB engine version.
- supports
Log booleanExports To Cloudwatch - Indicates whether the engine version supports exporting the log types specified by
exportable_log_typesto CloudWatch Logs. - supports
Parallel booleanQuery - Indicates whether you can use Aurora parallel query with a specific DB engine version.
- supports
Read booleanReplica - Indicates whether the database engine version supports read replicas.
- valid
Upgrade string[]Targets - Set of engine versions that this database engine version can be upgraded to.
- version string
- version
Description string - Description of the database engine version.
- default
Only boolean - filters
Get
Engine Version Filter[] - include
All boolean - preferred
Versions string[]
- default_
character_ strset - The default character set for new instances of this engine version.
- engine str
- engine_
description str - Description of the database engine.
- exportable_
log_ Sequence[str]types - Set of log types that the database engine has available for export to CloudWatch Logs.
- id str
- The provider-assigned unique ID for this managed resource.
- parameter_
group_ strfamily - status str
- Status of the DB engine version, either available or deprecated.
- supported_
character_ Sequence[str]sets - Set of the character sets supported by this engine.
- supported_
feature_ Sequence[str]names - Set of features supported by the DB engine.
- supported_
modes Sequence[str] - Set of the supported DB engine modes.
- supported_
timezones Sequence[str] - Set of the time zones supported by this engine.
- supports_
global_ booldatabases - Indicates whether you can use Aurora global databases with a specific DB engine version.
- supports_
log_ boolexports_ to_ cloudwatch - Indicates whether the engine version supports exporting the log types specified by
exportable_log_typesto CloudWatch Logs. - supports_
parallel_ boolquery - Indicates whether you can use Aurora parallel query with a specific DB engine version.
- supports_
read_ boolreplica - Indicates whether the database engine version supports read replicas.
- valid_
upgrade_ Sequence[str]targets - Set of engine versions that this database engine version can be upgraded to.
- version str
- version_
description str - Description of the database engine version.
- default_
only bool - filters
Sequence[Get
Engine Version Filter] - include_
all bool - preferred_
versions Sequence[str]
- default
Character StringSet - The default character set for new instances of this engine version.
- engine String
- engine
Description String - Description of the database engine.
- exportable
Log List<String>Types - Set of log types that the database engine has available for export to CloudWatch Logs.
- id String
- The provider-assigned unique ID for this managed resource.
- parameter
Group StringFamily - status String
- Status of the DB engine version, either available or deprecated.
- supported
Character List<String>Sets - Set of the character sets supported by this engine.
- supported
Feature List<String>Names - Set of features supported by the DB engine.
- supported
Modes List<String> - Set of the supported DB engine modes.
- supported
Timezones List<String> - Set of the time zones supported by this engine.
- supports
Global BooleanDatabases - Indicates whether you can use Aurora global databases with a specific DB engine version.
- supports
Log BooleanExports To Cloudwatch - Indicates whether the engine version supports exporting the log types specified by
exportable_log_typesto CloudWatch Logs. - supports
Parallel BooleanQuery - Indicates whether you can use Aurora parallel query with a specific DB engine version.
- supports
Read BooleanReplica - Indicates whether the database engine version supports read replicas.
- valid
Upgrade List<String>Targets - Set of engine versions that this database engine version can be upgraded to.
- version String
- version
Description String - Description of the database engine version.
- default
Only Boolean - filters List<Property Map>
- include
All Boolean - preferred
Versions List<String>
Supporting Types
GetEngineVersionFilter
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
published on Tuesday, Mar 10, 2026 by Pulumi
