@pulumi/yandex/getComputeInstance.d.ts

A Pulumi package for creating and managing yandex cloud resources.

import * as pulumi from "@pulumi/pulumi";
import { input as inputs, output as outputs } from "./types";
/**
 * Get information about a Yandex Compute instance. For more information, see
 * [the official documentation](https://cloud.yandex.com/docs/compute/concepts/vm).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as yandex from "@pulumi/yandex";
 *
 * const myInstance = pulumi.output(yandex.getComputeInstance({
 *     instanceId: "some_instance_id",
 * }));
 *
 * export const instanceExternalIp = myInstance.networkInterfaces[0].natIpAddress;
 * ```
 */
export declare function getComputeInstance(args?: GetComputeInstanceArgs, opts?: pulumi.InvokeOptions): Promise<GetComputeInstanceResult>;
/**
 * A collection of arguments for invoking getComputeInstance.
 */
export interface GetComputeInstanceArgs {
    /**
     * Folder that the resource belongs to. If value is omitted, the default provider folder is used.
     */
    folderId?: string;
    /**
     * The ID of a specific instance.
     */
    instanceId?: string;
    /**
     * Name of the instance.
     */
    name?: string;
    placementPolicy?: inputs.GetComputeInstancePlacementPolicy;
}
/**
 * A collection of values returned by getComputeInstance.
 */
export interface GetComputeInstanceResult {
    /**
     * The boot disk for the instance. Structure is documented below.
     */
    readonly bootDisks: outputs.GetComputeInstanceBootDisk[];
    /**
     * Instance creation timestamp.
     */
    readonly createdAt: string;
    /**
     * Description of the boot disk.
     */
    readonly description: string;
    readonly folderId: string;
    /**
     * DNS record FQDN.
     */
    readonly fqdn: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly instanceId: string;
    /**
     * A set of key/value label pairs assigned to the instance.
     */
    readonly labels: {
        [key: string]: string;
    };
    /**
     * Metadata key/value pairs to make available from
     * within the instance.
     */
    readonly metadata: {
        [key: string]: string;
    };
    /**
     * Name of the boot disk.
     */
    readonly name: string;
    /**
     * Type of network acceleration. The default is `standard`. Values: `standard`, `softwareAccelerated`
     */
    readonly networkAccelerationType: string;
    /**
     * The networks attached to the instance. Structure is documented below.
     * * `network_interface.0.ip_address` - An internal IP address of the instance, either manually or dynamically assigned.
     * * `network_interface.0.nat_ip_address` - An assigned external IP address if the instance has NAT enabled.
     */
    readonly networkInterfaces: outputs.GetComputeInstanceNetworkInterface[];
    readonly placementPolicy?: outputs.GetComputeInstancePlacementPolicy;
    /**
     * Type of virtual machine to create. Default is 'standard-v1'.
     */
    readonly platformId: string;
    readonly resources: outputs.GetComputeInstanceResource[];
    /**
     * Scheduling policy configuration. The structure is documented below.
     */
    readonly schedulingPolicies: outputs.GetComputeInstanceSchedulingPolicy[];
    /**
     * List of secondary disks attached to the instance. Structure is documented below.
     */
    readonly secondaryDisks: outputs.GetComputeInstanceSecondaryDisk[];
    /**
     * ID of the service account authorized for this instance.
     */
    readonly serviceAccountId: string;
    /**
     * Status of the instance.
     * * `resources.0.memory` - Memory size allocated for the instance.
     * * `resources.0.cores` - Number of CPU cores allocated for the instance.
     * * `resources.0.core_fraction` - Baseline performance for a core, set as a percent.
     * * `resources.0.gpus` - Number of GPU cores allocated for the instance.
     */
    readonly status: string;
    /**
     * Availability zone where the instance resides.
     */
    readonly zone: string;
}
export declare function getComputeInstanceOutput(args?: GetComputeInstanceOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetComputeInstanceResult>;
/**
 * A collection of arguments for invoking getComputeInstance.
 */
export interface GetComputeInstanceOutputArgs {
    /**
     * Folder that the resource belongs to. If value is omitted, the default provider folder is used.
     */
    folderId?: pulumi.Input<string>;
    /**
     * The ID of a specific instance.
     */
    instanceId?: pulumi.Input<string>;
    /**
     * Name of the instance.
     */
    name?: pulumi.Input<string>;
    placementPolicy?: pulumi.Input<inputs.GetComputeInstancePlacementPolicyArgs>;
}