Class CreateVolumeGroupBackupDetails
Inherited Members
Namespace: Oci.CoreService.Models
Assembly: OCI.DotNetSDK.Core.dll
Syntax
public class CreateVolumeGroupBackupDetails
Properties
CompartmentId
Declaration
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The OCID of the compartment that will contain the volume group backup. This parameter is optional, by default backup will be created in the same compartment and source volume group. |
DefinedTags
Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
| Type | Description |
|---|---|
| Dictionary<string, Dictionary<string, object>> | Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see Resource Tags.
|
DisplayName
Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
| Type | Description |
|---|---|
| string | A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
FreeformTags
Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
| Type | Description |
|---|---|
| Dictionary<string, string> | 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.
|
IsIndefiniteRetentionEnabled
Declaration
[JsonProperty(PropertyName = "isIndefiniteRetentionEnabled")]
public bool? IsIndefiniteRetentionEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? | 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. |
IsPreventDeletionEnabled
Declaration
[JsonProperty(PropertyName = "isPreventDeletionEnabled")]
public bool? IsPreventDeletionEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? | 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. |
IsRetentionLockEnabled
Declaration
[JsonProperty(PropertyName = "isRetentionLockEnabled")]
public bool? IsRetentionLockEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? | 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. |
RetentionPeriod
Declaration
[JsonProperty(PropertyName = "retentionPeriod")]
public RetentionDuration RetentionPeriod { get; set; }
Property Value
| Type | Description |
|---|---|
| RetentionDuration |
Type
Declaration
[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(StringEnumConverter))]
public CreateVolumeGroupBackupDetails.TypeEnum? Type { get; set; }
Property Value
| Type | Description |
|---|---|
| CreateVolumeGroupBackupDetails.TypeEnum? | The type of backup to create. If omitted, defaults to incremental. |
VolumeGroupId
Declaration
[Required(ErrorMessage = "VolumeGroupId is required.")]
[JsonProperty(PropertyName = "volumeGroupId")]
public string VolumeGroupId { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The OCID of the volume group that needs to be backed up. |
Remarks
Required