import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Volume Backup resource in Oracle Cloud Infrastructure Core service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/iaas/latest/VolumeBackup * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/ * * Creates a new backup of the specified volume. For general information about volume backups, * see [Overview of Block Volume Service Backups](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumebackups.htm) * * When the request is received, the backup object is in a REQUEST_RECEIVED state. * When the data is imaged, it goes into a CREATING state. * After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testVolumeBackup = new oci.core.VolumeBackup("test_volume_backup", { * volumeId: testVolume.id, * definedTags: { * "Operations.CostCenter": "42", * }, * displayName: volumeBackupDisplayName, * freeformTags: { * Department: "Finance", * }, * isIndefiniteRetentionEnabled: volumeBackupIsIndefiniteRetentionEnabled === "true", * isPreventDeletionEnabled: volumeBackupIsPreventDeletionEnabled === "true", * isRetentionLockEnabled: volumeBackupIsRetentionLockEnabled === "true", * kmsKeyId: testKey.id, * retentionPeriod: { * retentionTimeAmount: Number(volumeBackupRetentionPeriodRetentionTimeAmount), * retentionTimeUnit: volumeBackupRetentionPeriodRetentionTimeUnit, * }, * type: volumeBackupType, * }); * ``` * * ## Import * * VolumeBackups can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:Core/volumeBackup:VolumeBackup test_volume_backup "id" * ``` */ export declare class VolumeBackup extends pulumi.CustomResource { /** * Get an existing VolumeBackup 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?: VolumeBackupState, opts?: pulumi.CustomResourceOptions): VolumeBackup; /** * Returns true if the given object is an instance of VolumeBackup. 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 VolumeBackup; /** * (Updatable) The OCID of the compartment that contains the volume backup. */ readonly compartmentId: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ readonly displayName: pulumi.Output; /** * The date and time the volume backup will expire and be automatically deleted. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted. */ readonly expirationTime: pulumi.Output; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups. */ readonly isIndefiniteRetentionEnabled: pulumi.Output; /** * (Updatable) Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. */ readonly isPreventDeletionEnabled: pulumi.Output; /** * (Updatable) feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. */ readonly isRetentionLockEnabled: pulumi.Output; /** * (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see [Overview of Vault service](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm). */ readonly kmsKeyId: pulumi.Output; /** * (Updatable) This field is used to define the retention period for backups. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups. */ readonly retentionPeriod: pulumi.Output; /** * The size of the volume, in GBs. */ readonly sizeInGbs: pulumi.Output; /** * The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use `sizeInGbs`. * * @deprecated The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead. */ readonly sizeInMbs: pulumi.Output; /** * Details of the volume backup source in the cloud. */ readonly sourceDetails: pulumi.Output; /** * Specifies whether the backup was created manually, or via scheduled backup policy. */ readonly sourceType: pulumi.Output; /** * The OCID of the source volume backup. */ readonly sourceVolumeBackupId: pulumi.Output; /** * The current state of a volume backup. */ readonly state: pulumi.Output; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ readonly systemTags: pulumi.Output<{ [key: string]: string; }>; /** * The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ readonly timeCreated: pulumi.Output; /** * The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339. */ readonly timeRequestReceived: pulumi.Output; /** * The date and time when a backup’s retention period ends and it is set to expire. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups. */ readonly timeRetentionExpiresAt: pulumi.Output; /** * The type of backup to create. If omitted, defaults to INCREMENTAL. Supported values are 'FULL' or 'INCREMENTAL'. */ readonly type: pulumi.Output; /** * The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental. */ readonly uniqueSizeInGbs: pulumi.Output; /** * The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs. * * @deprecated The 'unique_size_in_mbs' field has been deprecated. Please use 'unique_size_in_gbs' instead. */ readonly uniqueSizeInMbs: pulumi.Output; /** * The OCID of the volume group backup associated with the backup. This is an optional field. If it is not present in the response, the backup does not belong to a volume group. */ readonly volumeGroupBackupId: pulumi.Output; /** * The OCID of the volume that needs to be backed up.**Note: To create the resource either `volumeId` or `sourceDetails` is required to be set. */ readonly volumeId: pulumi.Output; /** * Create a VolumeBackup 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?: VolumeBackupArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering VolumeBackup resources. */ export interface VolumeBackupState { /** * (Updatable) The OCID of the compartment that contains the volume backup. */ compartmentId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName?: pulumi.Input; /** * The date and time the volume backup will expire and be automatically deleted. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted. */ expirationTime?: pulumi.Input; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups. */ isIndefiniteRetentionEnabled?: pulumi.Input; /** * (Updatable) Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. */ isPreventDeletionEnabled?: pulumi.Input; /** * (Updatable) feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. */ isRetentionLockEnabled?: pulumi.Input; /** * (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see [Overview of Vault service](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm). */ kmsKeyId?: pulumi.Input; /** * (Updatable) This field is used to define the retention period for backups. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups. */ retentionPeriod?: pulumi.Input; /** * The size of the volume, in GBs. */ sizeInGbs?: pulumi.Input; /** * The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use `sizeInGbs`. * * @deprecated The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead. */ sizeInMbs?: pulumi.Input; /** * Details of the volume backup source in the cloud. */ sourceDetails?: pulumi.Input; /** * Specifies whether the backup was created manually, or via scheduled backup policy. */ sourceType?: pulumi.Input; /** * The OCID of the source volume backup. */ sourceVolumeBackupId?: pulumi.Input; /** * The current state of a volume backup. */ state?: pulumi.Input; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ systemTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated?: pulumi.Input; /** * The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339. */ timeRequestReceived?: pulumi.Input; /** * The date and time when a backup’s retention period ends and it is set to expire. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups. */ timeRetentionExpiresAt?: pulumi.Input; /** * The type of backup to create. If omitted, defaults to INCREMENTAL. Supported values are 'FULL' or 'INCREMENTAL'. */ type?: pulumi.Input; /** * The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental. */ uniqueSizeInGbs?: pulumi.Input; /** * The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs. * * @deprecated The 'unique_size_in_mbs' field has been deprecated. Please use 'unique_size_in_gbs' instead. */ uniqueSizeInMbs?: pulumi.Input; /** * The OCID of the volume group backup associated with the backup. This is an optional field. If it is not present in the response, the backup does not belong to a volume group. */ volumeGroupBackupId?: pulumi.Input; /** * The OCID of the volume that needs to be backed up.**Note: To create the resource either `volumeId` or `sourceDetails` is required to be set. */ volumeId?: pulumi.Input; } /** * The set of arguments for constructing a VolumeBackup resource. */ export interface VolumeBackupArgs { /** * (Updatable) The OCID of the compartment that contains the volume backup. */ compartmentId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName?: pulumi.Input; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups. */ isIndefiniteRetentionEnabled?: pulumi.Input; /** * (Updatable) Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. */ isPreventDeletionEnabled?: pulumi.Input; /** * (Updatable) feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. */ isRetentionLockEnabled?: pulumi.Input; /** * (Updatable) The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see [Overview of Vault service](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm). */ kmsKeyId?: pulumi.Input; /** * (Updatable) This field is used to define the retention period for backups. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups. */ retentionPeriod?: pulumi.Input; /** * Details of the volume backup source in the cloud. */ sourceDetails?: pulumi.Input; /** * The type of backup to create. If omitted, defaults to INCREMENTAL. Supported values are 'FULL' or 'INCREMENTAL'. */ type?: pulumi.Input; /** * The OCID of the volume that needs to be backed up.**Note: To create the resource either `volumeId` or `sourceDetails` is required to be set. */ volumeId?: pulumi.Input; } //# sourceMappingURL=volumeBackup.d.ts.map