@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
234 lines (233 loc) • 8.73 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* NetApp Volumes helps you manage your data usage with snapshots that can quickly restore lost data.
* Snapshots are point-in-time versions of your volume's content. They are resources of volumes and are
* instant captures of your data that consume space only for modified data. Because data changes over
* time, snapshots usually consume more space as they get older.
* NetApp Volumes volumes use just-in-time copy-on-write so that unmodified files in snapshots don't
* consume any of the volume's capacity.
*
* To get more information about VolumeSnapshot, see:
*
* * [API documentation](https://cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.volumes.snapshots)
* * How-to Guides
* * [Documentation](https://cloud.google.com/netapp/volumes/docs/configure-and-use/volume-snapshots/overview)
*
* ## Example Usage
*
* ### Volume Snapshot Create
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = gcp.compute.getNetwork({
* name: "test-network",
* });
* const defaultStoragePool = new gcp.netapp.StoragePool("default", {
* name: "test-pool",
* location: "us-west2",
* serviceLevel: "PREMIUM",
* capacityGib: "2048",
* network: _default.then(_default => _default.id),
* });
* const defaultVolume = new gcp.netapp.Volume("default", {
* location: defaultStoragePool.location,
* name: "test-volume",
* capacityGib: "100",
* shareName: "test-volume",
* storagePool: defaultStoragePool.name,
* protocols: ["NFSV3"],
* });
* const testSnapshot = new gcp.netapp.VolumeSnapshot("test_snapshot", {
* location: defaultVolume.location,
* volumeName: defaultVolume.name,
* name: "testvolumesnap",
* }, {
* dependsOn: [defaultVolume],
* });
* ```
*
* ## Import
*
* VolumeSnapshot can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/volumes/{{volume_name}}/snapshots/{{name}}`
*
* * `{{project}}/{{location}}/{{volume_name}}/{{name}}`
*
* * `{{location}}/{{volume_name}}/{{name}}`
*
* When using the `pulumi import` command, VolumeSnapshot can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:netapp/volumeSnapshot:VolumeSnapshot default projects/{{project}}/locations/{{location}}/volumes/{{volume_name}}/snapshots/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:netapp/volumeSnapshot:VolumeSnapshot default {{project}}/{{location}}/{{volume_name}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:netapp/volumeSnapshot:VolumeSnapshot default {{location}}/{{volume_name}}/{{name}}
* ```
*/
export declare class VolumeSnapshot extends pulumi.CustomResource {
/**
* Get an existing VolumeSnapshot 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?: VolumeSnapshotState, opts?: pulumi.CustomResourceOptions): VolumeSnapshot;
/**
* Returns true if the given object is an instance of VolumeSnapshot. 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 VolumeSnapshot;
/**
* Description for the snapshot.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* 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;
}>;
/**
* Labels as key value pairs. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }`.
*
* **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 snapshot location. Snapshots are child resources of volumes and live in the same location.
*/
readonly location: pulumi.Output<string>;
/**
* The name of the snapshot.
*/
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;
}>;
/**
* Storage used to store blocks unique to this snapshot.
*/
readonly usedBytes: pulumi.Output<number>;
/**
* The name of the volume to create the snapshot in.
*/
readonly volumeName: pulumi.Output<string>;
/**
* Create a VolumeSnapshot 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: VolumeSnapshotArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VolumeSnapshot resources.
*/
export interface VolumeSnapshotState {
/**
* Description for the snapshot.
*/
description?: pulumi.Input<string>;
/**
* 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>;
}>;
/**
* Labels as key value pairs. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }`.
*
* **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 snapshot location. Snapshots are child resources of volumes and live in the same location.
*/
location?: pulumi.Input<string>;
/**
* The name of the snapshot.
*/
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>;
}>;
/**
* Storage used to store blocks unique to this snapshot.
*/
usedBytes?: pulumi.Input<number>;
/**
* The name of the volume to create the snapshot in.
*/
volumeName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a VolumeSnapshot resource.
*/
export interface VolumeSnapshotArgs {
/**
* Description for the snapshot.
*/
description?: pulumi.Input<string>;
/**
* Labels as key value pairs. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }`.
*
* **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 snapshot location. Snapshots are child resources of volumes and live in the same location.
*/
location: pulumi.Input<string>;
/**
* The name of the snapshot.
*/
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 name of the volume to create the snapshot in.
*/
volumeName: pulumi.Input<string>;
}