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

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());
    }
}
Content copied to clipboard

With filter

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());
    }
}
Content copied to clipboard

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, includeAll: Boolean? = null, parameterGroupFamily: String? = null, preferredVersions: List<String>? = null, version: String? = null): GetEngineVersionResult

Return

A collection of values returned by getEngineVersion.

Parameters

defaultOnly

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.

engine

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.

filters

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

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

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

preferredVersions

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

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.

See also

.

suspend fun getEngineVersion(argument: suspend GetEngineVersionPlainArgsBuilder.() -> Unit): GetEngineVersionResult

Return

A collection of values returned by getEngineVersion.

Parameters

argument

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

See also

.