pulumi-aws-kotlin/com.pulumi.aws.rds.kotlin/RdsFunctions/getEngineVersion

getEngineVersion

suspend fun getEngineVersion(argument: GetEngineVersionPlainArgs): GetEngineVersionResult

Information about an RDS engine version.

Example Usage

Basic Usage

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

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/v6/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());
    }
}

variables:
  test:
    fn::invoke:
      function: aws:rds:getEngineVersion
      arguments:
        engine: mysql
        preferredVersions:
          - 8.0.27
          - 8.0.26

With `filter`

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = aws.rds.getEngineVersion({
    engine: "aurora-postgresql",
    version: "10.14",
    includeAll: true,
    filters: [{
        name: "engine-mode",
        values: ["serverless"],
    }],
});

import pulumi
import pulumi_aws as aws
test = aws.rds.get_engine_version(engine="aurora-postgresql",
    version="10.14",
    include_all=True,
    filters=[{
        "name": "engine-mode",
        "values": ["serverless"],
    }])

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",
        Version = "10.14",
        IncludeAll = true,
        Filters = new[]
        {
            new Aws.Rds.Inputs.GetEngineVersionFilterInputArgs
            {
                Name = "engine-mode",
                Values = new[]
                {
                    "serverless",
                },
            },
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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",
			Version:    pulumi.StringRef("10.14"),
			IncludeAll: pulumi.BoolRef(true),
			Filters: []rds.GetEngineVersionFilter{
				{
					Name: "engine-mode",
					Values: []string{
						"serverless",
					},
				},
			},
		}, 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")
            .version("10.14")
            .includeAll(true)
            .filters(GetEngineVersionFilterArgs.builder()
                .name("engine-mode")
                .values("serverless")
                .build())
            .build());
    }
}

variables:
  test:
    fn::invoke:
      function: aws:rds:getEngineVersion
      arguments:
        engine: aurora-postgresql
        version: '10.14'
        includeAll: true
        filters:
          - name: engine-mode
            values:
              - serverless

Return

A collection of values returned by getEngineVersion.

Parameters

argument

A collection of arguments for invoking getEngineVersion.

suspend fun getEngineVersion(defaultOnly: Boolean? = null, engine: String, filters: List<GetEngineVersionFilter>? = null, hasMajorTarget: Boolean? = null, hasMinorTarget: Boolean? = null, includeAll: Boolean? = null, latest: Boolean? = null, parameterGroupFamily: String? = null, preferredMajorTargets: List<String>? = null, preferredUpgradeTargets: List<String>? = null, preferredVersions: List<String>? = null, version: String? = null): GetEngineVersionResult

Return

A collection of values returned by getEngineVersion.

Parameters

defaultOnly

Whether the engine version must be an AWS-defined default version. Some engines have multiple default versions, such as for each major version. Using default_only may help avoid multiple RDS engine versions errors. See also latest.

engine

Database 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. The following arguments are optional:

filters

One or more name/value pairs to use in filtering versions. There are several valid keys; for a full reference, check out describe-db-engine-versions in the AWS CLI reference.

hasMajorTarget

Whether the engine version must have one or more major upgrade targets. Not including has_major_target or setting it to false doesn't imply that there's no corresponding major upgrade target for the engine version.

hasMinorTarget

Whether the engine version must have one or more minor upgrade targets. Not including has_minor_target or setting it to false doesn't imply that there's no corresponding minor upgrade target for the engine version.

includeAll

Whether the engine version status can either be deprecated or available. When not set or set to false, the engine version status will always be available.

latest

Whether the engine version is the most recent version matching the other criteria. This is different from default_only in important ways: "default" relies on AWS-defined defaults, the latest version isn't always the default, and AWS might have multiple default versions for an engine. As a result, default_only might not prevent errors from multiple RDS engine versions, while latest will. (latest can be used with default_only.) Note: The data source uses a best-effort approach at selecting the latest version. Due to the complexity of version identifiers across engines and incomplete version date information provided by AWS, using latest may not always result in the engine version being the actual latest version.

parameterGroupFamily

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

preferredMajorTargets

Ordered list of preferred major version upgrade targets. The engine version will be the first match in the list unless the latest parameter is set to true. The engine version will be the default version if you don't include any criteria, such as preferred_major_targets.

preferredUpgradeTargets

Ordered list of preferred version upgrade targets. The engine version will be the first match in this list unless the latest parameter is set to true. The engine version will be the default version if you don't include any criteria, such as preferred_upgrade_targets.

preferredVersions

Ordered list of preferred versions. The engine version will be the first match in this list unless the latest parameter is set to true. The engine version will be the default version if you don't include any criteria, such as preferred_versions.

version

Return

A collection of values returned by getEngineVersion.

Parameters

argument

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

getEngineVersion

Example Usage

Basic Usage

With filter

Return

Parameters

Return

Parameters

See also

Return

Parameters

See also

With `filter`