@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
214 lines (213 loc) • 9.79 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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
*
* ```typescript
* 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",
* ],
* });
* ```
*/
export declare function getEngineVersion(args?: GetEngineVersionArgs, opts?: pulumi.InvokeOptions): Promise<GetEngineVersionResult>;
/**
* A collection of arguments for invoking getEngineVersion.
*/
export interface GetEngineVersionArgs {
/**
* Whether to return only default engine versions that match all other criteria. AWS may define multiple default versions for a given engine, so using `defaultOnly` 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.
*/
defaultOnly?: boolean;
/**
* DB engine. Must be `neptune`. Default is `neptune`.
*/
engine?: string;
/**
* Whether to filter for engine versions that have a major target.
*/
hasMajorTarget?: boolean;
/**
* Whether to filter for engine versions that have a minor target.
*/
hasMinorTarget?: boolean;
/**
* Whether to return only the latest engine version that matches all other criteria. This differs from `defaultOnly`: AWS may define multiple defaults, and the latest version is not always marked as the default. As a result, `defaultOnly` 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.
*/
latest?: boolean;
/**
* 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.
*/
parameterGroupFamily?: string;
/**
* Ordered list of preferred major engine versions.
*/
preferredMajorTargets?: string[];
/**
* Ordered list of preferred upgrade engine versions.
*/
preferredUpgradeTargets?: 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, `1.0.1.0`, `1.0.2.2`, and `1.0.3.0`. 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 {
/**
* Default character set for the engine version.
*/
readonly defaultCharacterSet: string;
readonly defaultOnly?: boolean;
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[];
readonly hasMajorTarget?: boolean;
readonly hasMinorTarget?: boolean;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly latest?: boolean;
readonly parameterGroupFamily: string;
readonly preferredMajorTargets?: string[];
readonly preferredUpgradeTargets?: string[];
readonly preferredVersions?: string[];
readonly region: string;
/**
* Set of character sets supported by this engine version.
*/
readonly supportedCharacterSets: string[];
/**
* Set of time zones supported by this engine.
*/
readonly supportedTimezones: string[];
/**
* Whether the engine version supports global databases.
*/
readonly supportsGlobalDatabases: boolean;
/**
* Whether the engine version supports exporting the log types specified by `exportableLogTypes` to CloudWatch Logs.
*/
readonly supportsLogExportsToCloudwatch: boolean;
/**
* Whether the database engine version supports read replicas.
*/
readonly supportsReadReplica: boolean;
/**
* Set of valid major engine versions that this version can be upgraded to.
*/
readonly validMajorTargets: string[];
/**
* Set of valid minor engine versions that this version can be upgraded to.
*/
readonly validMinorTargets: string[];
/**
* Set of engine versions that this database engine version can be upgraded to.
*/
readonly validUpgradeTargets: string[];
readonly version: string;
/**
* Actual engine version returned by the API.
*/
readonly versionActual: string;
/**
* Description of the database engine version.
*/
readonly versionDescription: string;
}
/**
* 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
*
* ```typescript
* 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",
* ],
* });
* ```
*/
export declare function getEngineVersionOutput(args?: GetEngineVersionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetEngineVersionResult>;
/**
* A collection of arguments for invoking getEngineVersion.
*/
export interface GetEngineVersionOutputArgs {
/**
* Whether to return only default engine versions that match all other criteria. AWS may define multiple default versions for a given engine, so using `defaultOnly` 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.
*/
defaultOnly?: pulumi.Input<boolean>;
/**
* DB engine. Must be `neptune`. Default is `neptune`.
*/
engine?: pulumi.Input<string>;
/**
* Whether to filter for engine versions that have a major target.
*/
hasMajorTarget?: pulumi.Input<boolean>;
/**
* Whether to filter for engine versions that have a minor target.
*/
hasMinorTarget?: pulumi.Input<boolean>;
/**
* Whether to return only the latest engine version that matches all other criteria. This differs from `defaultOnly`: AWS may define multiple defaults, and the latest version is not always marked as the default. As a result, `defaultOnly` 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.
*/
latest?: pulumi.Input<boolean>;
/**
* 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.
*/
parameterGroupFamily?: pulumi.Input<string>;
/**
* Ordered list of preferred major engine versions.
*/
preferredMajorTargets?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Ordered list of preferred upgrade engine versions.
*/
preferredUpgradeTargets?: pulumi.Input<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, `1.0.1.0`, `1.0.2.2`, and `1.0.3.0`. 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>;
}