@pulumi/gcp/compute/instantSnapshot.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Represents an instant snapshot resource.
 *
 * An instant snapshot is an in-place backup of a disk that can be used to rapidly create a new disk in minutes.
 *
 * Instant snapshots capture data at a specific point in time. They are optimized for rapidly restoring captured
 * data to a new disk. Use instant snapshots to quickly recover data in cases where the zone and disk are still intact
 * but the data on the disk has been lost or corrupted
 *
 * To get more information about InstantSnapshot, see:
 *
 * * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/instantSnapshots)
 * * How-to Guides
 *     * [Official Documentation](https://cloud.google.com/compute/docs/disks/instant-snapshots)
 *
 * ## Example Usage
 *
 * ### Instant Snapshot Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const foo = new gcp.compute.Disk("foo", {
 *     name: "example-disk",
 *     type: "pd-ssd",
 *     size: 10,
 * });
 * const _default = new gcp.compute.InstantSnapshot("default", {
 *     name: "instant-snapshot",
 *     zone: "us-central1-a",
 *     sourceDisk: foo.selfLink,
 * });
 * ```
 *
 * ## Import
 *
 * InstantSnapshot can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/zones/{{zone}}/instantSnapshots/{{name}}`
 *
 * * `{{project}}/{{zone}}/{{name}}`
 *
 * * `{{zone}}/{{name}}`
 *
 * * `{{name}}`
 *
 * When using the `pulumi import` command, InstantSnapshot can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:compute/instantSnapshot:InstantSnapshot default projects/{{project}}/zones/{{zone}}/instantSnapshots/{{name}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:compute/instantSnapshot:InstantSnapshot default {{project}}/{{zone}}/{{name}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:compute/instantSnapshot:InstantSnapshot default {{zone}}/{{name}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:compute/instantSnapshot:InstantSnapshot default {{name}}
 * ```
 */
export declare class InstantSnapshot extends pulumi.CustomResource {
    /**
     * Get an existing InstantSnapshot resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstantSnapshotState, opts?: pulumi.CustomResourceOptions): InstantSnapshot;
    /**
     * Returns true if the given object is an instance of InstantSnapshot.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is InstantSnapshot;
    /**
     * Creation timestamp in RFC3339 text format.
     */
    readonly creationTimestamp: pulumi.Output<string>;
    /**
     * An optional description of this resource.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Size of the snapshot, specified in GB.
     */
    readonly diskSizeGb: pulumi.Output<number>;
    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    readonly effectiveLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * The fingerprint used for optimistic locking of this resource. Used
     * internally during updates.
     */
    readonly labelFingerprint: pulumi.Output<string>;
    /**
     * Labels to apply to this InstantSnapshot.
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    readonly labels: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * Name of the resource; provided by the client when the resource is
     * created. The name must be 1-63 characters long, and comply with
     * RFC1035. Specifically, the name must be 1-63 characters long and match
     * the regular expression `a-z?` which means the
     * first character must be a lowercase letter, and all following
     * characters must be a dash, lowercase letter, or digit, except the last
     * character, which cannot be a dash.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * The combination of labels configured directly on the resource
     * and default labels configured on the provider.
     */
    readonly pulumiLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * The URI of the created resource.
     */
    readonly selfLink: pulumi.Output<string>;
    /**
     * A reference to the disk used to create this instant snapshot.
     */
    readonly sourceDisk: pulumi.Output<string>;
    /**
     * The ID value of the disk used to create this InstantSnapshot.
     */
    readonly sourceDiskId: pulumi.Output<string>;
    /**
     * A reference to the zone where the disk is located.
     */
    readonly zone: pulumi.Output<string>;
    /**
     * Create a InstantSnapshot resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: InstantSnapshotArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering InstantSnapshot resources.
 */
export interface InstantSnapshotState {
    /**
     * Creation timestamp in RFC3339 text format.
     */
    creationTimestamp?: pulumi.Input<string>;
    /**
     * An optional description of this resource.
     */
    description?: pulumi.Input<string>;
    /**
     * Size of the snapshot, specified in GB.
     */
    diskSizeGb?: pulumi.Input<number>;
    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    effectiveLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The fingerprint used for optimistic locking of this resource. Used
     * internally during updates.
     */
    labelFingerprint?: pulumi.Input<string>;
    /**
     * Labels to apply to this InstantSnapshot.
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Name of the resource; provided by the client when the resource is
     * created. The name must be 1-63 characters long, and comply with
     * RFC1035. Specifically, the name must be 1-63 characters long and match
     * the regular expression `a-z?` which means the
     * first character must be a lowercase letter, and all following
     * characters must be a dash, lowercase letter, or digit, except the last
     * character, which cannot be a dash.
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
    /**
     * The combination of labels configured directly on the resource
     * and default labels configured on the provider.
     */
    pulumiLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The URI of the created resource.
     */
    selfLink?: pulumi.Input<string>;
    /**
     * A reference to the disk used to create this instant snapshot.
     */
    sourceDisk?: pulumi.Input<string>;
    /**
     * The ID value of the disk used to create this InstantSnapshot.
     */
    sourceDiskId?: pulumi.Input<string>;
    /**
     * A reference to the zone where the disk is located.
     */
    zone?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a InstantSnapshot resource.
 */
export interface InstantSnapshotArgs {
    /**
     * An optional description of this resource.
     */
    description?: pulumi.Input<string>;
    /**
     * Labels to apply to this InstantSnapshot.
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Name of the resource; provided by the client when the resource is
     * created. The name must be 1-63 characters long, and comply with
     * RFC1035. Specifically, the name must be 1-63 characters long and match
     * the regular expression `a-z?` which means the
     * first character must be a lowercase letter, and all following
     * characters must be a dash, lowercase letter, or digit, except the last
     * character, which cannot be a dash.
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
    /**
     * A reference to the disk used to create this instant snapshot.
     */
    sourceDisk: pulumi.Input<string>;
    /**
     * A reference to the zone where the disk is located.
     */
    zone?: pulumi.Input<string>;
}