Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. docdb
  5. getEngineVersion
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

aws.docdb.getEngineVersion

Explore with Pulumi AI

AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

Information about a DocumentDB engine version.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = aws.docdb.getEngineVersion({
    version: "3.6.0",
});
Copy
import pulumi
import pulumi_aws as aws

test = aws.docdb.get_engine_version(version="3.6.0")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = Aws.DocDB.GetEngineVersion.Invoke(new()
    {
        Version = "3.6.0",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.docdb.DocdbFunctions;
import com.pulumi.aws.docdb.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 = DocdbFunctions.getEngineVersion(GetEngineVersionArgs.builder()
            .version("3.6.0")
            .build());

    }
}
Copy
variables:
  test:
    fn::invoke:
      function: aws:docdb:getEngineVersion
      arguments:
        version: 3.6.0
Copy

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>
Copy
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]
Copy
func GetEngineVersion(ctx *Context, args *GetEngineVersionArgs, opts ...InvokeOption) (*GetEngineVersionResult, error)
func GetEngineVersionOutput(ctx *Context, args *GetEngineVersionOutputArgs, opts ...InvokeOption) GetEngineVersionResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetEngineVersionResult> getEngineVersion(GetEngineVersionArgs args, InvokeOptions options)
public static Output<GetEngineVersionResult> getEngineVersion(GetEngineVersionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:docdb/getEngineVersion:getEngineVersion
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Engine string
DB engine. (Default: docdb)
ParameterGroupFamily string
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
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
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
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
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
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
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
Description of the database engine version.
Engine string
PreferredVersions List<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
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
Description of the database engine version.
Engine string
PreferredVersions []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
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
Description of the database engine version.
engine String
preferredVersions List<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
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
Description of the database engine version.
engine string
preferredVersions string[]
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
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
Description of the database engine version.
engine str
preferred_versions Sequence[str]
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
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
Description of the database engine version.
engine String
preferredVersions 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.
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws