import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * NetApp Volumes supports volume backups, which are copies of your volumes * stored independently from the volume. Backups are stored in backup vaults, * which are containers for backups. If a volume is lost or deleted, you can * use backups to restore your data to a new volume. * * When you create the first backup of a volume, all of the volume's used * data is sent to the backup vault. Subsequent backups of the same volume * only include data that has changed from the previous backup. This allows * for fast incremental-forever backups and reduces the required capacity * inside the backup vault. * * You can create manual and scheduled backups. Manual backups can be taken * from a volume or from an existing volume snapshot. Scheduled backups * require a backup policy. * * To get more information about Backup, see: * * * [API documentation](https://cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.backupVaults.backups) * * How-to Guides * * [Documentation](https://cloud.google.com/netapp/volumes/docs/protect-data/about-volume-backups) * * ## Example Usage * * ### Netapp Backup * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = gcp.compute.getNetwork({ * name: "network", * }); * const defaultStoragePool = new gcp.netapp.StoragePool("default", { * name: "backup-pool", * location: "us-central1", * serviceLevel: "PREMIUM", * capacityGib: "2048", * network: _default.then(_default => _default.id), * }); * const defaultBackupVault = new gcp.netapp.BackupVault("default", { * name: "backup-vault", * location: defaultStoragePool.location, * }); * const defaultVolume = new gcp.netapp.Volume("default", { * name: "backup-volume", * location: defaultStoragePool.location, * capacityGib: "100", * shareName: "backup-volume", * storagePool: defaultStoragePool.name, * protocols: ["NFSV3"], * deletionPolicy: "FORCE", * backupConfig: { * backupVault: defaultBackupVault.id, * }, * }); * const testBackup = new gcp.netapp.Backup("test_backup", { * name: "test-backup", * location: defaultBackupVault.location, * vaultName: defaultBackupVault.name, * sourceVolume: defaultVolume.id, * }); * ``` * * ## Import * * Backup can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/backupVaults/{{vault_name}}/backups/{{name}}` * * `{{project}}/{{location}}/{{vault_name}}/{{name}}` * * `{{location}}/{{vault_name}}/{{name}}` * * When using the `pulumi import` command, Backup can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:netapp/backup:Backup default projects/{{project}}/locations/{{location}}/backupVaults/{{vault_name}}/backups/{{name}} * $ pulumi import gcp:netapp/backup:Backup default {{project}}/{{location}}/{{vault_name}}/{{name}} * $ pulumi import gcp:netapp/backup:Backup default {{location}}/{{vault_name}}/{{name}} * ``` */ export declare class Backup extends pulumi.CustomResource { /** * Get an existing Backup 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, state?: BackupState, opts?: pulumi.CustomResourceOptions): Backup; /** * Returns true if the given object is an instance of Backup. 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 Backup; /** * Region in which backup is stored. */ readonly backupRegion: pulumi.Output; /** * Type of backup, manually created or created by a backup policy. Possible Values : [TYPE_UNSPECIFIED, MANUAL, SCHEDULED] */ readonly backupType: pulumi.Output; /** * Backups of a volume build incrementally on top of each other. They form a "backup chain". * Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size) */ readonly chainStorageBytes: pulumi.Output; /** * Create time of the backup. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z". */ readonly createTime: pulumi.Output; /** * 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; /** * A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. */ readonly description: pulumi.Output; /** * 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>; /** * Location of the backup. */ readonly location: pulumi.Output; /** * The resource name of the backup. Needs to be unique per location. */ readonly name: pulumi.Output; /** * (Optional, Beta) * Details of the ONTAP source volume and snapshot. * Structure is documented below. */ readonly ontapSource: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ readonly pulumiLabels: pulumi.Output<{ [key: string]: string; }>; /** * If specified, backup will be created from the given snapshot. If not specified, * there will be a new snapshot taken to initiate the backup creation. * Format: `projects/{{projectId}}/locations/{{location}}/volumes/{{volumename}}/snapshots/{{snapshotname}}`` */ readonly sourceSnapshot: pulumi.Output; /** * ID of volumes this backup belongs to. Format: `projects/{{projects_id}}/locations/{{location}}/volumes/{{name}}`` */ readonly sourceVolume: pulumi.Output; /** * The state of the Backup Vault. Possible Values : [STATE_UNSPECIFIED, CREATING, UPLOADING, READY, DELETING, ERROR, UPDATING] */ readonly state: pulumi.Output; /** * Name of the backup vault to store the backup in. */ readonly vaultName: pulumi.Output; /** * Region of the volume from which the backup was created. */ readonly volumeRegion: pulumi.Output; /** * Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big. */ readonly volumeUsageBytes: pulumi.Output; /** * Create a Backup 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: BackupArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Backup resources. */ export interface BackupState { /** * Region in which backup is stored. */ backupRegion?: pulumi.Input; /** * Type of backup, manually created or created by a backup policy. Possible Values : [TYPE_UNSPECIFIED, MANUAL, SCHEDULED] */ backupType?: pulumi.Input; /** * Backups of a volume build incrementally on top of each other. They form a "backup chain". * Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size) */ chainStorageBytes?: pulumi.Input; /** * Create time of the backup. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z". */ createTime?: pulumi.Input; /** * 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; /** * A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. */ description?: pulumi.Input; /** * 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; } | undefined>; /** * 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; } | undefined>; /** * Location of the backup. */ location?: pulumi.Input; /** * The resource name of the backup. Needs to be unique per location. */ name?: pulumi.Input; /** * (Optional, Beta) * Details of the ONTAP source volume and snapshot. * Structure is documented below. */ ontapSource?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * If specified, backup will be created from the given snapshot. If not specified, * there will be a new snapshot taken to initiate the backup creation. * Format: `projects/{{projectId}}/locations/{{location}}/volumes/{{volumename}}/snapshots/{{snapshotname}}`` */ sourceSnapshot?: pulumi.Input; /** * ID of volumes this backup belongs to. Format: `projects/{{projects_id}}/locations/{{location}}/volumes/{{name}}`` */ sourceVolume?: pulumi.Input; /** * The state of the Backup Vault. Possible Values : [STATE_UNSPECIFIED, CREATING, UPLOADING, READY, DELETING, ERROR, UPDATING] */ state?: pulumi.Input; /** * Name of the backup vault to store the backup in. */ vaultName?: pulumi.Input; /** * Region of the volume from which the backup was created. */ volumeRegion?: pulumi.Input; /** * Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big. */ volumeUsageBytes?: pulumi.Input; } /** * The set of arguments for constructing a Backup resource. */ export interface BackupArgs { /** * 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; /** * A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. */ description?: pulumi.Input; /** * 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; } | undefined>; /** * Location of the backup. */ location: pulumi.Input; /** * The resource name of the backup. Needs to be unique per location. */ name?: pulumi.Input; /** * (Optional, Beta) * Details of the ONTAP source volume and snapshot. * Structure is documented below. */ ontapSource?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * If specified, backup will be created from the given snapshot. If not specified, * there will be a new snapshot taken to initiate the backup creation. * Format: `projects/{{projectId}}/locations/{{location}}/volumes/{{volumename}}/snapshots/{{snapshotname}}`` */ sourceSnapshot?: pulumi.Input; /** * ID of volumes this backup belongs to. Format: `projects/{{projects_id}}/locations/{{location}}/volumes/{{name}}`` */ sourceVolume?: pulumi.Input; /** * Name of the backup vault to store the backup in. */ vaultName: pulumi.Input; } //# sourceMappingURL=backup.d.ts.map