AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

getEngineVersion

Information about a DocumentDB engine version.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var test = Output.Create(Aws.DocDB.GetEngineVersion.InvokeAsync(new Aws.DocDB.GetEngineVersionArgs
        {
            Version = "3.6.0",
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/docdb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := docdb.GetEngineVersion(ctx, &docdb.GetEngineVersionArgs{
			Version: pulumi.StringRef("3.6.0"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var test = Output.of(DocdbFunctions.getEngineVersion(GetEngineVersionArgs.builder()
            .version("3.6.0")
            .build()));

    }
}
import pulumi
import pulumi_aws as aws

test = aws.docdb.get_engine_version(version="3.6.0")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = pulumi.output(aws.docdb.getEngineVersion({
    version: "3.6.0",
}));
variables:
  test:
    Fn::Invoke:
      Function: aws:docdb:getEngineVersion
      Arguments:
        version: 3.6.0

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(engine: Optional[str] = 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(engine: Optional[pulumi.Input[str]] = 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:docdb/getEngineVersion:getEngineVersion
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Engine string

DB engine. (Default: docdb)

ParameterGroupFamily string

The name of a specific DB parameter group family. An example parameter group family is docdb3.6.

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, 3.6.0. If version and preferred_versions are not set, the data source will provide information for the AWS-defined default version. 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. (Default: docdb)

ParameterGroupFamily string

The name of a specific DB parameter group family. An example parameter group family is docdb3.6.

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, 3.6.0. If version and preferred_versions are not set, the data source will provide information for the AWS-defined default version. 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. (Default: docdb)

parameterGroupFamily String

The name of a specific DB parameter group family. An example parameter group family is docdb3.6.

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, 3.6.0. If version and preferred_versions are not set, the data source will provide information for the AWS-defined default version. 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. (Default: docdb)

parameterGroupFamily string

The name of a specific DB parameter group family. An example parameter group family is docdb3.6.

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, 3.6.0. If version and preferred_versions are not set, the data source will provide information for the AWS-defined default version. 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. (Default: docdb)

parameter_group_family str

The name of a specific DB parameter group family. An example parameter group family is docdb3.6.

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, 3.6.0. If version and preferred_versions are not set, the data source will provide information for the AWS-defined default version. 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. (Default: docdb)

parameterGroupFamily String

The name of a specific DB parameter group family. An example parameter group family is docdb3.6.

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, 3.6.0. If version and preferred_versions are not set, the data source will provide information for the AWS-defined default version. 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:

EngineDescription string

The 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
SupportsLogExportsToCloudwatch bool

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

ValidUpgradeTargets List<string>

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

Version string
VersionDescription string

The description of the database engine version.

Engine string
PreferredVersions List<string>
EngineDescription string

The 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
SupportsLogExportsToCloudwatch bool

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

ValidUpgradeTargets []string

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

Version string
VersionDescription string

The description of the database engine version.

Engine string
PreferredVersions []string
engineDescription String

The 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
supportsLogExportsToCloudwatch Boolean

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

validUpgradeTargets List<String>

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

version String
versionDescription String

The description of the database engine version.

engine String
preferredVersions List<String>
engineDescription string

The 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
supportsLogExportsToCloudwatch boolean

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

validUpgradeTargets string[]

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

version string
versionDescription string

The description of the database engine version.

engine string
preferredVersions string[]
engine_description str

The 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
supports_log_exports_to_cloudwatch bool

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

valid_upgrade_targets Sequence[str]

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

version str
version_description str

The description of the database engine version.

engine str
preferred_versions Sequence[str]
engineDescription String

The 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
supportsLogExportsToCloudwatch Boolean

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

validUpgradeTargets List<String>

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

version String
versionDescription String

The description of the database engine version.

engine String
preferredVersions List<String>

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.