@pulumi/aws/docdb/getEngineVersion.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Information about a DocumentDB engine version.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const test = aws.docdb.getEngineVersion({
 *     version: "3.6.0",
 * });
 * ```
 */
export declare function getEngineVersion(args?: GetEngineVersionArgs, opts?: pulumi.InvokeOptions): Promise<GetEngineVersionResult>;
/**
 * A collection of arguments for invoking getEngineVersion.
 */
export interface GetEngineVersionArgs {
    /**
     * DB engine. (Default: `docdb`)
     */
    engine?: string;
    /**
     * Name of a specific DB parameter group family. An example parameter group family is `docdb3.6`.
     */
    parameterGroupFamily?: 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 `preferredVersions` arguments are not configured, the data source will return the default version for the engine.
     */
    preferredVersions?: string[];
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: string;
    /**
     * Version of the DB engine. For example, `3.6.0`. If `version` and `preferredVersions` are not set, the data source will provide information for the AWS-defined default version. If both the `version` and `preferredVersions` arguments are not configured, the data source will return the default version for the engine.
     */
    version?: string;
}
/**
 * A collection of values returned by getEngineVersion.
 */
export interface GetEngineVersionResult {
    readonly engine?: string;
    /**
     * Description of the database engine.
     */
    readonly engineDescription: string;
    /**
     * Set of log types that the database engine has available for export to CloudWatch Logs.
     */
    readonly exportableLogTypes: string[];
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly parameterGroupFamily: string;
    readonly preferredVersions?: string[];
    readonly region: string;
    /**
     * Indicates whether the engine version supports exporting the log types specified by `exportableLogTypes` to CloudWatch Logs.
     */
    readonly supportsLogExportsToCloudwatch: boolean;
    /**
     * A set of engine versions that this database engine version can be upgraded to.
     */
    readonly validUpgradeTargets: string[];
    readonly version: string;
    /**
     * Description of the database engine version.
     */
    readonly versionDescription: string;
}
/**
 * Information about a DocumentDB engine version.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const test = aws.docdb.getEngineVersion({
 *     version: "3.6.0",
 * });
 * ```
 */
export declare function getEngineVersionOutput(args?: GetEngineVersionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetEngineVersionResult>;
/**
 * A collection of arguments for invoking getEngineVersion.
 */
export interface GetEngineVersionOutputArgs {
    /**
     * DB engine. (Default: `docdb`)
     */
    engine?: pulumi.Input<string>;
    /**
     * Name of a specific DB parameter group family. An example parameter group family is `docdb3.6`.
     */
    parameterGroupFamily?: pulumi.Input<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 `preferredVersions` arguments are not configured, the data source will return the default version for the engine.
     */
    preferredVersions?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * Version of the DB engine. For example, `3.6.0`. If `version` and `preferredVersions` are not set, the data source will provide information for the AWS-defined default version. If both the `version` and `preferredVersions` arguments are not configured, the data source will return the default version for the engine.
     */
    version?: pulumi.Input<string>;
}