@pulumiverse/scaleway/opensearch/getDeployment.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Gets information about an OpenSearch deployment.
 *
 * For more information refer to the [product documentation](https://www.scaleway.com/en/docs/opensearch/).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * // Get info by name
 * const byName = scaleway.opensearch.getDeployment({
 *     name: "my-opensearch-cluster",
 * });
 * // Get info by deployment ID
 * const byId = scaleway.opensearch.getDeployment({
 *     deploymentId: "11111111-1111-1111-1111-111111111111",
 * });
 * ```
 */
export declare function getDeployment(args?: GetDeploymentArgs, opts?: pulumi.InvokeOptions): Promise<GetDeploymentResult>;
/**
 * A collection of arguments for invoking getDeployment.
 */
export interface GetDeploymentArgs {
    /**
     * The ID of the OpenSearch deployment. Only one of `name` and `deploymentId` should be specified.
     */
    deploymentId?: string;
    /**
     * The name of the OpenSearch deployment. Only one of `name` and `deploymentId` should be specified.
     */
    name?: string;
    /**
     * The ID of the project the OpenSearch deployment is associated with.
     */
    projectId?: string;
    /**
     * `region`) The region in which the deployment exists.
     */
    region?: string;
}
/**
 * A collection of values returned by getDeployment.
 */
export interface GetDeploymentResult {
    readonly createdAt: string;
    readonly deploymentId?: string;
    readonly endpoints: outputs.opensearch.GetDeploymentEndpoint[];
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly name?: string;
    readonly nodeAmount: number;
    readonly nodeCount: number;
    readonly nodeType: string;
    readonly password: string;
    readonly privateNetworks: outputs.opensearch.GetDeploymentPrivateNetwork[];
    readonly projectId?: string;
    readonly publicDashboardUrl: string;
    readonly region?: string;
    readonly status: string;
    readonly tags: string[];
    readonly updatedAt: string;
    readonly userName: string;
    readonly version: string;
    readonly volumes: outputs.opensearch.GetDeploymentVolume[];
}
/**
 * Gets information about an OpenSearch deployment.
 *
 * For more information refer to the [product documentation](https://www.scaleway.com/en/docs/opensearch/).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * // Get info by name
 * const byName = scaleway.opensearch.getDeployment({
 *     name: "my-opensearch-cluster",
 * });
 * // Get info by deployment ID
 * const byId = scaleway.opensearch.getDeployment({
 *     deploymentId: "11111111-1111-1111-1111-111111111111",
 * });
 * ```
 */
export declare function getDeploymentOutput(args?: GetDeploymentOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDeploymentResult>;
/**
 * A collection of arguments for invoking getDeployment.
 */
export interface GetDeploymentOutputArgs {
    /**
     * The ID of the OpenSearch deployment. Only one of `name` and `deploymentId` should be specified.
     */
    deploymentId?: pulumi.Input<string | undefined>;
    /**
     * The name of the OpenSearch deployment. Only one of `name` and `deploymentId` should be specified.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The ID of the project the OpenSearch deployment is associated with.
     */
    projectId?: pulumi.Input<string | undefined>;
    /**
     * `region`) The region in which the deployment exists.
     */
    region?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getDeployment.d.ts.map