Docs Packages
  1. Pulumi Registry
  2. AWS Classic
  3. API Docs
  4. rds
  5. getEngineVersion
aws logo
AWS Classic v5.41.0, May 15 23

aws.rds.getEngineVersion

Explore with Pulumi AI

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 pulumi
import pulumi_aws as aws

test = aws.rds.get_engine_version(engine="mysql",
    preferred_versions=[
        "8.0.27",
        "8.0.26",
    ])

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",
    ],
});

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 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")

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",
});

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)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:rds/getEngineVersion:getEngineVersion
  arguments:
    # arguments dictionary

The 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, and sqlserver-web.

DefaultOnly bool

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.

Filters List<GetEngineVersionFilter>

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 bool

When set to true, the specified version or member of preferred_versions will be returned even if it is deprecated. Otherwise, only available versions will be returned.

ParameterGroupFamily string

Name of a specific DB parameter group family. Examples of parameter group families are mysql8.0, mariadb10.4, and postgres12.

PreferredVersions 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 version and preferred_versions arguments 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, and 12.3. If both the version and preferred_versions arguments 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, and sqlserver-web.

DefaultOnly bool

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.

Filters []GetEngineVersionFilter

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 bool

When set to true, the specified version or member of preferred_versions will be returned even if it is deprecated. Otherwise, only available versions will be returned.

ParameterGroupFamily string

Name of a specific DB parameter group family. Examples of parameter group families are mysql8.0, mariadb10.4, and postgres12.

PreferredVersions []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 version and preferred_versions arguments 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, and 12.3. If both the version and preferred_versions arguments 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, and sqlserver-web.

defaultOnly Boolean

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.

filters List<GetEngineVersionFilter>

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 Boolean

When set to true, the specified version or member of preferred_versions will be returned even if it is deprecated. Otherwise, only available versions will be returned.

parameterGroupFamily String

Name of a specific DB parameter group family. Examples of parameter group families are mysql8.0, mariadb10.4, and postgres12.

preferredVersions 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 version and preferred_versions arguments 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, and 12.3. If both the version and preferred_versions arguments 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, and sqlserver-web.

defaultOnly boolean

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.

filters GetEngineVersionFilter[]

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 boolean

When set to true, the specified version or member of preferred_versions will be returned even if it is deprecated. Otherwise, only available versions will be returned.

parameterGroupFamily string

Name of a specific DB parameter group family. Examples of parameter group families are mysql8.0, mariadb10.4, and postgres12.

preferredVersions 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 version and preferred_versions arguments 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, and 12.3. If both the version and preferred_versions arguments 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, and sqlserver-web.

default_only bool

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.

filters Sequence[GetEngineVersionFilter]

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 specified version or member of preferred_versions will be returned even if it is deprecated. Otherwise, only available versions will be returned.

parameter_group_family str

Name of a specific DB parameter group family. Examples of parameter group families are mysql8.0, mariadb10.4, and postgres12.

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 version and preferred_versions arguments 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, and 12.3. If both the version and preferred_versions arguments 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, and sqlserver-web.

defaultOnly Boolean

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.

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.

includeAll Boolean

When set to true, the specified version or member of preferred_versions will be returned even if it is deprecated. Otherwise, only available versions will be returned.

parameterGroupFamily String

Name of a specific DB parameter group family. Examples of parameter group families are mysql8.0, mariadb10.4, and postgres12.

preferredVersions 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 version and preferred_versions arguments 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, and 12.3. If both the version and preferred_versions arguments are not configured, the data source will return the default version for the engine.

getEngineVersion Result

The following output properties are available:

DefaultCharacterSet string

The default character set for new instances of this engine version.

Engine string
EngineDescription string

Description of the database engine.

ExportableLogTypes List<string>

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.

ParameterGroupFamily string
Status string

Status of the DB engine version, either available or deprecated.

SupportedCharacterSets List<string>

Set of the character sets supported by this engine.

SupportedFeatureNames List<string>

Set of features supported by the DB engine.

SupportedModes List<string>

Set of the supported DB engine modes.

SupportedTimezones List<string>

Set of the time zones supported by this engine.

SupportsGlobalDatabases bool

Indicates whether you can use Aurora global databases with a specific DB engine version.

SupportsLogExportsToCloudwatch bool

Indicates whether the engine version supports exporting the log types specified by exportable_log_types to CloudWatch Logs.

SupportsParallelQuery bool

Indicates whether you can use Aurora parallel query with a specific DB engine version.

SupportsReadReplica bool

Indicates whether the database engine version supports read replicas.

ValidUpgradeTargets List<string>

Set of engine versions that this database engine version can be upgraded to.

Version string
VersionDescription string

Description of the database engine version.

DefaultOnly bool
Filters List<GetEngineVersionFilter>
IncludeAll bool
PreferredVersions List<string>
DefaultCharacterSet string

The default character set for new instances of this engine version.

Engine string
EngineDescription string

Description of the database engine.

ExportableLogTypes []string

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.

ParameterGroupFamily string
Status string

Status of the DB engine version, either available or deprecated.

SupportedCharacterSets []string

Set of the character sets supported by this engine.

SupportedFeatureNames []string

Set of features supported by the DB engine.

SupportedModes []string

Set of the supported DB engine modes.

SupportedTimezones []string

Set of the time zones supported by this engine.

SupportsGlobalDatabases bool

Indicates whether you can use Aurora global databases with a specific DB engine version.

SupportsLogExportsToCloudwatch bool

Indicates whether the engine version supports exporting the log types specified by exportable_log_types to CloudWatch Logs.

SupportsParallelQuery bool

Indicates whether you can use Aurora parallel query with a specific DB engine version.

SupportsReadReplica bool

Indicates whether the database engine version supports read replicas.

ValidUpgradeTargets []string

Set of engine versions that this database engine version can be upgraded to.

Version string
VersionDescription string

Description of the database engine version.

DefaultOnly bool
Filters []GetEngineVersionFilter
IncludeAll bool
PreferredVersions []string
defaultCharacterSet String

The default character set for new instances of this engine version.

engine String
engineDescription String

Description of the database engine.

exportableLogTypes List<String>

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.

parameterGroupFamily String
status String

Status of the DB engine version, either available or deprecated.

supportedCharacterSets List<String>

Set of the character sets supported by this engine.

supportedFeatureNames List<String>

Set of features supported by the DB engine.

supportedModes List<String>

Set of the supported DB engine modes.

supportedTimezones List<String>

Set of the time zones supported by this engine.

supportsGlobalDatabases Boolean

Indicates whether you can use Aurora global databases with a specific DB engine version.

supportsLogExportsToCloudwatch Boolean

Indicates whether the engine version supports exporting the log types specified by exportable_log_types to CloudWatch Logs.

supportsParallelQuery Boolean

Indicates whether you can use Aurora parallel query with a specific DB engine version.

supportsReadReplica Boolean

Indicates whether the database engine version supports read replicas.

validUpgradeTargets List<String>

Set of engine versions that this database engine version can be upgraded to.

version String
versionDescription String

Description of the database engine version.

defaultOnly Boolean
filters List<GetEngineVersionFilter>
includeAll Boolean
preferredVersions List<String>
defaultCharacterSet string

The default character set for new instances of this engine version.

engine string
engineDescription string

Description of the database engine.

exportableLogTypes string[]

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.

parameterGroupFamily string
status string

Status of the DB engine version, either available or deprecated.

supportedCharacterSets string[]

Set of the character sets supported by this engine.

supportedFeatureNames string[]

Set of features supported by the DB engine.

supportedModes string[]

Set of the supported DB engine modes.

supportedTimezones string[]

Set of the time zones supported by this engine.

supportsGlobalDatabases boolean

Indicates whether you can use Aurora global databases with a specific DB engine version.

supportsLogExportsToCloudwatch boolean

Indicates whether the engine version supports exporting the log types specified by exportable_log_types to CloudWatch Logs.

supportsParallelQuery boolean

Indicates whether you can use Aurora parallel query with a specific DB engine version.

supportsReadReplica boolean

Indicates whether the database engine version supports read replicas.

validUpgradeTargets string[]

Set of engine versions that this database engine version can be upgraded to.

version string
versionDescription string

Description of the database engine version.

defaultOnly boolean
filters GetEngineVersionFilter[]
includeAll boolean
preferredVersions string[]
default_character_set str

The default character set for new instances of this engine version.

engine str
engine_description str

Description of the database engine.

exportable_log_types Sequence[str]

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_family str
status str

Status of the DB engine version, either available or deprecated.

supported_character_sets Sequence[str]

Set of the character sets supported by this engine.

supported_feature_names Sequence[str]

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_databases bool

Indicates whether you can use Aurora global databases with a specific DB engine version.

supports_log_exports_to_cloudwatch bool

Indicates whether the engine version supports exporting the log types specified by exportable_log_types to CloudWatch Logs.

supports_parallel_query bool

Indicates whether you can use Aurora parallel query with a specific DB engine version.

supports_read_replica bool

Indicates whether the database engine version supports read replicas.

valid_upgrade_targets Sequence[str]

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[GetEngineVersionFilter]
include_all bool
preferred_versions Sequence[str]
defaultCharacterSet String

The default character set for new instances of this engine version.

engine String
engineDescription String

Description of the database engine.

exportableLogTypes List<String>

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.

parameterGroupFamily String
status String

Status of the DB engine version, either available or deprecated.

supportedCharacterSets List<String>

Set of the character sets supported by this engine.

supportedFeatureNames List<String>

Set of features supported by the DB engine.

supportedModes List<String>

Set of the supported DB engine modes.

supportedTimezones List<String>

Set of the time zones supported by this engine.

supportsGlobalDatabases Boolean

Indicates whether you can use Aurora global databases with a specific DB engine version.

supportsLogExportsToCloudwatch Boolean

Indicates whether the engine version supports exporting the log types specified by exportable_log_types to CloudWatch Logs.

supportsParallelQuery Boolean

Indicates whether you can use Aurora parallel query with a specific DB engine version.

supportsReadReplica Boolean

Indicates whether the database engine version supports read replicas.

validUpgradeTargets List<String>

Set of engine versions that this database engine version can be upgraded to.

version String
versionDescription String

Description of the database engine version.

defaultOnly Boolean
filters List<Property Map>
includeAll Boolean
preferredVersions List<String>

Supporting Types

GetEngineVersionFilter

Name string
Values List<string>
Name string
Values []string
name String
values List<String>
name string
values string[]
name str
values Sequence[str]
name String
values List<String>

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.