Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. neptune
  5. getEngineVersion
AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws

aws.neptune.getEngineVersion

Explore with Pulumi AI

aws logo
AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws

    Information about a Neptune engine version.

    Note: If AWS returns multiple matching engine versions, this data source will produce a multiple Neptune engine versions error. To avoid this, provide additional criteria to narrow the results or use the latest argument to select a single version. See the Argument Reference for details.

    Example Usage

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

const test = aws.neptune.getEngineVersion({
    preferredVersions: [
        "1.4.5.0",
        "1.4.4.0",
        "1.4.3.0",
    ],
});

    import pulumi
import pulumi_aws as aws

test = aws.neptune.get_engine_version(preferred_versions=[
    "1.4.5.0",
    "1.4.4.0",
    "1.4.3.0",
])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/neptune"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := neptune.GetEngineVersion(ctx, &neptune.GetEngineVersionArgs{
			PreferredVersions: []string{
				"1.4.5.0",
				"1.4.4.0",
				"1.4.3.0",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = Aws.Neptune.GetEngineVersion.Invoke(new()
    {
        PreferredVersions = new[]
        {
            "1.4.5.0",
            "1.4.4.0",
            "1.4.3.0",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.neptune.NeptuneFunctions;
import com.pulumi.aws.neptune.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 = NeptuneFunctions.getEngineVersion(GetEngineVersionArgs.builder()
            .preferredVersions(            
                "1.4.5.0",
                "1.4.4.0",
                "1.4.3.0")
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      function: aws:neptune:getEngineVersion
      arguments:
        preferredVersions:
          - 1.4.5.0
          - 1.4.4.0
          - 1.4.3.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(default_only: Optional[bool] = None,
                       engine: Optional[str] = None,
                       has_major_target: Optional[bool] = None,
                       has_minor_target: Optional[bool] = None,
                       latest: Optional[bool] = None,
                       parameter_group_family: Optional[str] = None,
                       preferred_major_targets: Optional[Sequence[str]] = None,
                       preferred_upgrade_targets: Optional[Sequence[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,
                       has_major_target: Optional[pulumi.Input[bool]] = None,
                       has_minor_target: Optional[pulumi.Input[bool]] = None,
                       latest: Optional[pulumi.Input[bool]] = None,
                       parameter_group_family: Optional[pulumi.Input[str]] = None,
                       preferred_major_targets: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                       preferred_upgrade_targets: Optional[pulumi.Input[Sequence[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)
public static Output<GetEngineVersionResult> getEngineVersion(GetEngineVersionArgs args, InvokeOptions options)

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

    The following arguments are supported:

    DefaultOnly bool
    Whether to return only default engine versions that match all other criteria. AWS may define multiple default versions for a given engine, so using default_only alone does not guarantee that only one version will be returned. To ensure a single version is selected, consider combining this with latest. Note that default versions are defined by AWS and may not reflect the most recent engine version available.
    Engine string
    DB engine. Must be neptune. Default is neptune.
    HasMajorTarget bool
    Whether to filter for engine versions that have a major target.
    HasMinorTarget bool
    Whether to filter for engine versions that have a minor target.
    Latest bool
    Whether to return only the latest engine version that matches all other criteria. This differs from default_only: AWS may define multiple defaults, and the latest version is not always marked as the default. As a result, default_only may still return multiple versions, while latest selects a single version. The two options can be used together. Note: This argument uses a best-effort approach. Because AWS does not consistently provide version dates or standardized identifiers, the result may not always reflect the true latest version.
    ParameterGroupFamily string
    Name of a specific DB parameter group family. An example parameter group family is neptune1.4. For some versions, if this is provided, AWS returns no results.
    PreferredMajorTargets List<string>
    Ordered list of preferred major engine versions.
    PreferredUpgradeTargets List<string>
    Ordered list of preferred upgrade engine versions.
    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, 1.0.1.0, 1.0.2.2, and 1.0.3.0. If both the version and preferred_versions arguments are not configured, the data source will return the default version for the engine.
    DefaultOnly bool
    Whether to return only default engine versions that match all other criteria. AWS may define multiple default versions for a given engine, so using default_only alone does not guarantee that only one version will be returned. To ensure a single version is selected, consider combining this with latest. Note that default versions are defined by AWS and may not reflect the most recent engine version available.
    Engine string
    DB engine. Must be neptune. Default is neptune.
    HasMajorTarget bool
    Whether to filter for engine versions that have a major target.
    HasMinorTarget bool
    Whether to filter for engine versions that have a minor target.
    Latest bool
    Whether to return only the latest engine version that matches all other criteria. This differs from default_only: AWS may define multiple defaults, and the latest version is not always marked as the default. As a result, default_only may still return multiple versions, while latest selects a single version. The two options can be used together. Note: This argument uses a best-effort approach. Because AWS does not consistently provide version dates or standardized identifiers, the result may not always reflect the true latest version.
    ParameterGroupFamily string
    Name of a specific DB parameter group family. An example parameter group family is neptune1.4. For some versions, if this is provided, AWS returns no results.
    PreferredMajorTargets []string
    Ordered list of preferred major engine versions.
    PreferredUpgradeTargets []string
    Ordered list of preferred upgrade engine versions.
    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, 1.0.1.0, 1.0.2.2, and 1.0.3.0. If both the version and preferred_versions arguments are not configured, the data source will return the default version for the engine.
    defaultOnly Boolean
    Whether to return only default engine versions that match all other criteria. AWS may define multiple default versions for a given engine, so using default_only alone does not guarantee that only one version will be returned. To ensure a single version is selected, consider combining this with latest. Note that default versions are defined by AWS and may not reflect the most recent engine version available.
    engine String
    DB engine. Must be neptune. Default is neptune.
    hasMajorTarget Boolean
    Whether to filter for engine versions that have a major target.
    hasMinorTarget Boolean
    Whether to filter for engine versions that have a minor target.
    latest Boolean
    Whether to return only the latest engine version that matches all other criteria. This differs from default_only: AWS may define multiple defaults, and the latest version is not always marked as the default. As a result, default_only may still return multiple versions, while latest selects a single version. The two options can be used together. Note: This argument uses a best-effort approach. Because AWS does not consistently provide version dates or standardized identifiers, the result may not always reflect the true latest version.
    parameterGroupFamily String
    Name of a specific DB parameter group family. An example parameter group family is neptune1.4. For some versions, if this is provided, AWS returns no results.
    preferredMajorTargets List<String>
    Ordered list of preferred major engine versions.
    preferredUpgradeTargets List<String>
    Ordered list of preferred upgrade engine versions.
    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, 1.0.1.0, 1.0.2.2, and 1.0.3.0. If both the version and preferred_versions arguments are not configured, the data source will return the default version for the engine.
    defaultOnly boolean
    Whether to return only default engine versions that match all other criteria. AWS may define multiple default versions for a given engine, so using default_only alone does not guarantee that only one version will be returned. To ensure a single version is selected, consider combining this with latest. Note that default versions are defined by AWS and may not reflect the most recent engine version available.
    engine string
    DB engine. Must be neptune. Default is neptune.
    hasMajorTarget boolean
    Whether to filter for engine versions that have a major target.
    hasMinorTarget boolean
    Whether to filter for engine versions that have a minor target.
    latest boolean
    Whether to return only the latest engine version that matches all other criteria. This differs from default_only: AWS may define multiple defaults, and the latest version is not always marked as the default. As a result, default_only may still return multiple versions, while latest selects a single version. The two options can be used together. Note: This argument uses a best-effort approach. Because AWS does not consistently provide version dates or standardized identifiers, the result may not always reflect the true latest version.
    parameterGroupFamily string
    Name of a specific DB parameter group family. An example parameter group family is neptune1.4. For some versions, if this is provided, AWS returns no results.
    preferredMajorTargets string[]
    Ordered list of preferred major engine versions.
    preferredUpgradeTargets string[]
    Ordered list of preferred upgrade engine versions.
    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, 1.0.1.0, 1.0.2.2, and 1.0.3.0. If both the version and preferred_versions arguments are not configured, the data source will return the default version for the engine.
    default_only bool
    Whether to return only default engine versions that match all other criteria. AWS may define multiple default versions for a given engine, so using default_only alone does not guarantee that only one version will be returned. To ensure a single version is selected, consider combining this with latest. Note that default versions are defined by AWS and may not reflect the most recent engine version available.
    engine str
    DB engine. Must be neptune. Default is neptune.
    has_major_target bool
    Whether to filter for engine versions that have a major target.
    has_minor_target bool
    Whether to filter for engine versions that have a minor target.
    latest bool
    Whether to return only the latest engine version that matches all other criteria. This differs from default_only: AWS may define multiple defaults, and the latest version is not always marked as the default. As a result, default_only may still return multiple versions, while latest selects a single version. The two options can be used together. Note: This argument uses a best-effort approach. Because AWS does not consistently provide version dates or standardized identifiers, the result may not always reflect the true latest version.
    parameter_group_family str
    Name of a specific DB parameter group family. An example parameter group family is neptune1.4. For some versions, if this is provided, AWS returns no results.
    preferred_major_targets Sequence[str]
    Ordered list of preferred major engine versions.
    preferred_upgrade_targets Sequence[str]
    Ordered list of preferred upgrade engine versions.
    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, 1.0.1.0, 1.0.2.2, and 1.0.3.0. If both the version and preferred_versions arguments are not configured, the data source will return the default version for the engine.
    defaultOnly Boolean
    Whether to return only default engine versions that match all other criteria. AWS may define multiple default versions for a given engine, so using default_only alone does not guarantee that only one version will be returned. To ensure a single version is selected, consider combining this with latest. Note that default versions are defined by AWS and may not reflect the most recent engine version available.
    engine String
    DB engine. Must be neptune. Default is neptune.
    hasMajorTarget Boolean
    Whether to filter for engine versions that have a major target.
    hasMinorTarget Boolean
    Whether to filter for engine versions that have a minor target.
    latest Boolean
    Whether to return only the latest engine version that matches all other criteria. This differs from default_only: AWS may define multiple defaults, and the latest version is not always marked as the default. As a result, default_only may still return multiple versions, while latest selects a single version. The two options can be used together. Note: This argument uses a best-effort approach. Because AWS does not consistently provide version dates or standardized identifiers, the result may not always reflect the true latest version.
    parameterGroupFamily String
    Name of a specific DB parameter group family. An example parameter group family is neptune1.4. For some versions, if this is provided, AWS returns no results.
    preferredMajorTargets List<String>
    Ordered list of preferred major engine versions.
    preferredUpgradeTargets List<String>
    Ordered list of preferred upgrade engine versions.
    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, 1.0.1.0, 1.0.2.2, and 1.0.3.0. 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
    Default character set for the engine version.
    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
    SupportedCharacterSets List<string>
    Set of character sets supported by this engine version.
    SupportedTimezones List<string>
    Set of time zones supported by this engine.
    SupportsGlobalDatabases bool
    Whether the engine version supports global databases.
    SupportsLogExportsToCloudwatch bool
    Whether the engine version supports exporting the log types specified by exportable_log_types to CloudWatch Logs.
    SupportsReadReplica bool
    Whether the database engine version supports read replicas.
    ValidMajorTargets List<string>
    Set of valid major engine versions that this version can be upgraded to.
    ValidMinorTargets List<string>
    Set of valid minor engine versions that this version can be upgraded to.
    ValidUpgradeTargets List<string>
    Set of engine versions that this database engine version can be upgraded to.
    Version string
    VersionActual string
    Actual engine version returned by the API.
    VersionDescription string
    Description of the database engine version.
    DefaultOnly bool
    Engine string
    HasMajorTarget bool
    HasMinorTarget bool
    Latest bool
    PreferredMajorTargets List<string>
    PreferredUpgradeTargets List<string>
    PreferredVersions List<string>
    DefaultCharacterSet string
    Default character set for the engine version.
    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
    SupportedCharacterSets []string
    Set of character sets supported by this engine version.
    SupportedTimezones []string
    Set of time zones supported by this engine.
    SupportsGlobalDatabases bool
    Whether the engine version supports global databases.
    SupportsLogExportsToCloudwatch bool
    Whether the engine version supports exporting the log types specified by exportable_log_types to CloudWatch Logs.
    SupportsReadReplica bool
    Whether the database engine version supports read replicas.
    ValidMajorTargets []string
    Set of valid major engine versions that this version can be upgraded to.
    ValidMinorTargets []string
    Set of valid minor engine versions that this version can be upgraded to.
    ValidUpgradeTargets []string
    Set of engine versions that this database engine version can be upgraded to.
    Version string
    VersionActual string
    Actual engine version returned by the API.
    VersionDescription string
    Description of the database engine version.
    DefaultOnly bool
    Engine string
    HasMajorTarget bool
    HasMinorTarget bool
    Latest bool
    PreferredMajorTargets []string
    PreferredUpgradeTargets []string
    PreferredVersions []string
    defaultCharacterSet String
    Default character set for the engine version.
    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
    supportedCharacterSets List<String>
    Set of character sets supported by this engine version.
    supportedTimezones List<String>
    Set of time zones supported by this engine.
    supportsGlobalDatabases Boolean
    Whether the engine version supports global databases.
    supportsLogExportsToCloudwatch Boolean
    Whether the engine version supports exporting the log types specified by exportable_log_types to CloudWatch Logs.
    supportsReadReplica Boolean
    Whether the database engine version supports read replicas.
    validMajorTargets List<String>
    Set of valid major engine versions that this version can be upgraded to.
    validMinorTargets List<String>
    Set of valid minor engine versions that this version can be upgraded to.
    validUpgradeTargets List<String>
    Set of engine versions that this database engine version can be upgraded to.
    version String
    versionActual String
    Actual engine version returned by the API.
    versionDescription String
    Description of the database engine version.
    defaultOnly Boolean
    engine String
    hasMajorTarget Boolean
    hasMinorTarget Boolean
    latest Boolean
    preferredMajorTargets List<String>
    preferredUpgradeTargets List<String>
    preferredVersions List<String>
    defaultCharacterSet string
    Default character set for the engine version.
    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
    supportedCharacterSets string[]
    Set of character sets supported by this engine version.
    supportedTimezones string[]
    Set of time zones supported by this engine.
    supportsGlobalDatabases boolean
    Whether the engine version supports global databases.
    supportsLogExportsToCloudwatch boolean
    Whether the engine version supports exporting the log types specified by exportable_log_types to CloudWatch Logs.
    supportsReadReplica boolean
    Whether the database engine version supports read replicas.
    validMajorTargets string[]
    Set of valid major engine versions that this version can be upgraded to.
    validMinorTargets string[]
    Set of valid minor engine versions that this version can be upgraded to.
    validUpgradeTargets string[]
    Set of engine versions that this database engine version can be upgraded to.
    version string
    versionActual string
    Actual engine version returned by the API.
    versionDescription string
    Description of the database engine version.
    defaultOnly boolean
    engine string
    hasMajorTarget boolean
    hasMinorTarget boolean
    latest boolean
    preferredMajorTargets string[]
    preferredUpgradeTargets string[]
    preferredVersions string[]
    default_character_set str
    Default character set for the engine version.
    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
    supported_character_sets Sequence[str]
    Set of character sets supported by this engine version.
    supported_timezones Sequence[str]
    Set of time zones supported by this engine.
    supports_global_databases bool
    Whether the engine version supports global databases.
    supports_log_exports_to_cloudwatch bool
    Whether the engine version supports exporting the log types specified by exportable_log_types to CloudWatch Logs.
    supports_read_replica bool
    Whether the database engine version supports read replicas.
    valid_major_targets Sequence[str]
    Set of valid major engine versions that this version can be upgraded to.
    valid_minor_targets Sequence[str]
    Set of valid minor engine versions that this version can be upgraded to.
    valid_upgrade_targets Sequence[str]
    Set of engine versions that this database engine version can be upgraded to.
    version str
    version_actual str
    Actual engine version returned by the API.
    version_description str
    Description of the database engine version.
    default_only bool
    engine str
    has_major_target bool
    has_minor_target bool
    latest bool
    preferred_major_targets Sequence[str]
    preferred_upgrade_targets Sequence[str]
    preferred_versions Sequence[str]
    defaultCharacterSet String
    Default character set for the engine version.
    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
    supportedCharacterSets List<String>
    Set of character sets supported by this engine version.
    supportedTimezones List<String>
    Set of time zones supported by this engine.
    supportsGlobalDatabases Boolean
    Whether the engine version supports global databases.
    supportsLogExportsToCloudwatch Boolean
    Whether the engine version supports exporting the log types specified by exportable_log_types to CloudWatch Logs.
    supportsReadReplica Boolean
    Whether the database engine version supports read replicas.
    validMajorTargets List<String>
    Set of valid major engine versions that this version can be upgraded to.
    validMinorTargets List<String>
    Set of valid minor engine versions that this version can be upgraded to.
    validUpgradeTargets List<String>
    Set of engine versions that this database engine version can be upgraded to.
    version String
    versionActual String
    Actual engine version returned by the API.
    versionDescription String
    Description of the database engine version.
    defaultOnly Boolean
    engine String
    hasMajorTarget Boolean
    hasMinorTarget Boolean
    latest Boolean
    preferredMajorTargets List<String>
    preferredUpgradeTargets List<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 logo
    AWS v6.83.0 published on Monday, Jun 16, 2025 by Pulumi
    pulumi/pulumi-aws