@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
334 lines • 13.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A backup vault is the location where backups are stored. You can only create one backup vault per region.
* A vault can hold multiple backups for multiple volumes in that region.
*
* To get more information about BackupVault, see:
*
* * [API documentation](https://cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.backupVaults)
* * How-to Guides
* * [Documentation](https://cloud.google.com/netapp/volumes/docs/protect-data/about-volume-backups)
*
* ## Example Usage
*
* ### Netapp Backup Vault
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const testBackupVault = new gcp.netapp.BackupVault("test_backup_vault", {
* name: "test-backup-vault",
* location: "us-west1",
* description: "Terraform created vault",
* labels: {
* creator: "testuser",
* },
* });
* ```
*
* ## Import
*
* BackupVault can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/backupVaults/{{name}}`
* * `{{project}}/{{location}}/{{name}}`
* * `{{location}}/{{name}}`
*
* When using the `pulumi import` command, BackupVault can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:netapp/backupVault:BackupVault default projects/{{project}}/locations/{{location}}/backupVaults/{{name}}
* $ pulumi import gcp:netapp/backupVault:BackupVault default {{project}}/{{location}}/{{name}}
* $ pulumi import gcp:netapp/backupVault:BackupVault default {{location}}/{{name}}
* ```
*/
export declare class BackupVault extends pulumi.CustomResource {
/**
* Get an existing BackupVault 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?: BackupVaultState, opts?: pulumi.CustomResourceOptions): BackupVault;
/**
* Returns true if the given object is an instance of BackupVault. 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 BackupVault;
/**
* Region in which backup is stored.
*/
readonly backupRegion: pulumi.Output<string | undefined>;
/**
* Backup retention policy defining the retention of the backups.
* Structure is documented below.
*/
readonly backupRetentionPolicy: pulumi.Output<outputs.netapp.BackupVaultBackupRetentionPolicy | undefined>;
/**
* Type of the backup vault to be created. Default is IN_REGION.
* Possible values are: `BACKUP_VAULT_TYPE_UNSPECIFIED`, `IN_REGION`, `CROSS_REGION`.
*/
readonly backupVaultType: pulumi.Output<string>;
/**
* The crypto key version used to encrypt the backup vault.
* Format:
* `projects/{{project}}/locations/{{location}}/keyRings/{{key_ring}}/cryptoKeys/{{crypto_key}}/cryptoKeyVersions/{{crypto_key_version}}`
*/
readonly backupsCryptoKeyVersion: pulumi.Output<string>;
/**
* Create time of the backup vault. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
*/
readonly createTime: 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>;
/**
* Name of the Backup vault created in backup region.
*/
readonly destinationBackupVault: pulumi.Output<string>;
/**
* 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;
}>;
/**
* Encryption state of customer-managed encryption keys (CMEK) backups.
*/
readonly encryptionState: pulumi.Output<string>;
/**
* Specifies the Key Management System (KMS) configuration to be used for
* backup encryption. Format:
* `projects/{{project}}/locations/{{location}}/kmsConfigs/{{kms_config}}`
*/
readonly kmsConfig: pulumi.Output<string | 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.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Location (region) of the backup vault.
*/
readonly location: pulumi.Output<string>;
/**
* The resource name of the backup vault. Needs to be unique per location.
*/
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;
}>;
/**
* Name of the Backup vault created in source region.
*/
readonly sourceBackupVault: pulumi.Output<string>;
/**
* Region in which the backup vault is created.
*/
readonly sourceRegion: pulumi.Output<string>;
/**
* The state of the Backup Vault.
*/
readonly state: pulumi.Output<string>;
/**
* Create a BackupVault 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: BackupVaultArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering BackupVault resources.
*/
export interface BackupVaultState {
/**
* Region in which backup is stored.
*/
backupRegion?: pulumi.Input<string | undefined>;
/**
* Backup retention policy defining the retention of the backups.
* Structure is documented below.
*/
backupRetentionPolicy?: pulumi.Input<inputs.netapp.BackupVaultBackupRetentionPolicy | undefined>;
/**
* Type of the backup vault to be created. Default is IN_REGION.
* Possible values are: `BACKUP_VAULT_TYPE_UNSPECIFIED`, `IN_REGION`, `CROSS_REGION`.
*/
backupVaultType?: pulumi.Input<string | undefined>;
/**
* The crypto key version used to encrypt the backup vault.
* Format:
* `projects/{{project}}/locations/{{location}}/keyRings/{{key_ring}}/cryptoKeys/{{crypto_key}}/cryptoKeyVersions/{{crypto_key_version}}`
*/
backupsCryptoKeyVersion?: pulumi.Input<string | undefined>;
/**
* Create time of the backup vault. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
*/
createTime?: 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>;
/**
* Name of the Backup vault created in backup region.
*/
destinationBackupVault?: pulumi.Input<string | 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>;
/**
* Encryption state of customer-managed encryption keys (CMEK) backups.
*/
encryptionState?: pulumi.Input<string | undefined>;
/**
* Specifies the Key Management System (KMS) configuration to be used for
* backup encryption. Format:
* `projects/{{project}}/locations/{{location}}/kmsConfigs/{{kms_config}}`
*/
kmsConfig?: pulumi.Input<string | 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<string>;
} | undefined>;
/**
* Location (region) of the backup vault.
*/
location?: pulumi.Input<string | undefined>;
/**
* The resource name of the backup vault. Needs to be unique per location.
*/
name?: pulumi.Input<string | 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>;
/**
* Name of the Backup vault created in source region.
*/
sourceBackupVault?: pulumi.Input<string | undefined>;
/**
* Region in which the backup vault is created.
*/
sourceRegion?: pulumi.Input<string | undefined>;
/**
* The state of the Backup Vault.
*/
state?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a BackupVault resource.
*/
export interface BackupVaultArgs {
/**
* Region in which backup is stored.
*/
backupRegion?: pulumi.Input<string | undefined>;
/**
* Backup retention policy defining the retention of the backups.
* Structure is documented below.
*/
backupRetentionPolicy?: pulumi.Input<inputs.netapp.BackupVaultBackupRetentionPolicy | undefined>;
/**
* Type of the backup vault to be created. Default is IN_REGION.
* Possible values are: `BACKUP_VAULT_TYPE_UNSPECIFIED`, `IN_REGION`, `CROSS_REGION`.
*/
backupVaultType?: 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>;
/**
* Specifies the Key Management System (KMS) configuration to be used for
* backup encryption. Format:
* `projects/{{project}}/locations/{{location}}/kmsConfigs/{{kms_config}}`
*/
kmsConfig?: pulumi.Input<string | 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<string>;
} | undefined>;
/**
* Location (region) of the backup vault.
*/
location: pulumi.Input<string>;
/**
* The resource name of the backup vault. Needs to be unique per location.
*/
name?: pulumi.Input<string | 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>;
}
//# sourceMappingURL=backupVault.d.ts.map