@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
354 lines • 14.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* 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 RegionInstantSnapshot, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/regionInstantSnapshots)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/compute/docs/disks/instant-snapshots)
*
* ## Example Usage
*
* ### Region Instant Snapshot Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const foo = new gcp.compute.RegionDisk("foo", {
* name: "example-disk",
* type: "pd-ssd",
* region: "us-central1",
* size: 10,
* replicaZones: [
* "us-central1-a",
* "us-central1-f",
* ],
* });
* const _default = new gcp.compute.RegionInstantSnapshot("default", {
* name: "instant-snapshot",
* region: "us-central1",
* sourceDisk: foo.selfLink,
* });
* ```
*
* ## Import
*
* RegionInstantSnapshot can be imported using any of these accepted formats:
*
* * `projects/{{project}}/regions/{{region}}/instantSnapshots/{{name}}`
* * `{{project}}/{{region}}/{{name}}`
* * `{{region}}/{{name}}`
* * `{{name}}`
*
* When using the `pulumi import` command, RegionInstantSnapshot can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/regionInstantSnapshot:RegionInstantSnapshot default projects/{{project}}/regions/{{region}}/instantSnapshots/{{name}}
* $ pulumi import gcp:compute/regionInstantSnapshot:RegionInstantSnapshot default {{project}}/{{region}}/{{name}}
* $ pulumi import gcp:compute/regionInstantSnapshot:RegionInstantSnapshot default {{region}}/{{name}}
* $ pulumi import gcp:compute/regionInstantSnapshot:RegionInstantSnapshot default {{name}}
* ```
*/
export declare class RegionInstantSnapshot extends pulumi.CustomResource {
/**
* Get an existing RegionInstantSnapshot 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?: RegionInstantSnapshotState, opts?: pulumi.CustomResourceOptions): RegionInstantSnapshot;
/**
* Returns true if the given object is an instance of RegionInstantSnapshot. 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 RegionInstantSnapshot;
/**
* The architecture of the instant snapshot.
*/
readonly architecture: pulumi.Output<string>;
/**
* Creation timestamp in RFC3339 text format.
*/
readonly creationTimestamp: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: 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>;
/**
* Additional params passed with the request, but not persisted as part of resource payload
* Structure is documented below.
*/
readonly params: pulumi.Output<outputs.compute.RegionInstantSnapshotParams | undefined>;
/**
* 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;
}>;
/**
* A reference to the region where the disk is located.
*/
readonly region: pulumi.Output<string>;
/**
* Resource status for the instant snapshot.
* Structure is documented below.
*/
readonly resourceStatuses: pulumi.Output<outputs.compute.RegionInstantSnapshotResourceStatus[]>;
/**
* The URI of the created resource.
*/
readonly selfLink: pulumi.Output<string>;
/**
* The source disk used to create this instant snapshot. You can provide this as a partial or full URL to the resource.
*/
readonly sourceDisk: pulumi.Output<string>;
/**
* The ID value of the disk used to create this InstantSnapshot.
*/
readonly sourceDiskId: pulumi.Output<string>;
/**
* URL of the source instant snapshot group.
*/
readonly sourceInstantSnapshotGroup: pulumi.Output<string>;
/**
* The unique ID of the source instant snapshot group.
*/
readonly sourceInstantSnapshotGroupId: pulumi.Output<string>;
/**
* The status of the instant snapshot.
*/
readonly status: pulumi.Output<string>;
/**
* Create a RegionInstantSnapshot 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: RegionInstantSnapshotArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RegionInstantSnapshot resources.
*/
export interface RegionInstantSnapshotState {
/**
* The architecture of the instant snapshot.
*/
architecture?: pulumi.Input<string | undefined>;
/**
* Creation timestamp in RFC3339 text format.
*/
creationTimestamp?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string | undefined>;
/**
* Size of the snapshot, specified in GB.
*/
diskSizeGb?: pulumi.Input<number | undefined>;
/**
* 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>;
} | undefined>;
/**
* The fingerprint used for optimistic locking of this resource. Used
* internally during updates.
*/
labelFingerprint?: pulumi.Input<string | undefined>;
/**
* 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>;
} | 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.
*/
name?: pulumi.Input<string | undefined>;
/**
* Additional params passed with the request, but not persisted as part of resource payload
* Structure is documented below.
*/
params?: pulumi.Input<inputs.compute.RegionInstantSnapshotParams | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* A reference to the region where the disk is located.
*/
region?: pulumi.Input<string | undefined>;
/**
* Resource status for the instant snapshot.
* Structure is documented below.
*/
resourceStatuses?: pulumi.Input<pulumi.Input<inputs.compute.RegionInstantSnapshotResourceStatus>[] | undefined>;
/**
* The URI of the created resource.
*/
selfLink?: pulumi.Input<string | undefined>;
/**
* The source disk used to create this instant snapshot. You can provide this as a partial or full URL to the resource.
*/
sourceDisk?: pulumi.Input<string | undefined>;
/**
* The ID value of the disk used to create this InstantSnapshot.
*/
sourceDiskId?: pulumi.Input<string | undefined>;
/**
* URL of the source instant snapshot group.
*/
sourceInstantSnapshotGroup?: pulumi.Input<string | undefined>;
/**
* The unique ID of the source instant snapshot group.
*/
sourceInstantSnapshotGroupId?: pulumi.Input<string | undefined>;
/**
* The status of the instant snapshot.
*/
status?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a RegionInstantSnapshot resource.
*/
export interface RegionInstantSnapshotArgs {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string | undefined>;
/**
* 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>;
} | 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.
*/
name?: pulumi.Input<string | undefined>;
/**
* Additional params passed with the request, but not persisted as part of resource payload
* Structure is documented below.
*/
params?: pulumi.Input<inputs.compute.RegionInstantSnapshotParams | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* A reference to the region where the disk is located.
*/
region?: pulumi.Input<string | undefined>;
/**
* The source disk used to create this instant snapshot. You can provide this as a partial or full URL to the resource.
*/
sourceDisk: pulumi.Input<string>;
}
//# sourceMappingURL=regionInstantSnapshot.d.ts.map