Class FilesystemSnapshotPolicy
A file system snapshot policy is used to automate snapshot creation and deletion.
It contains a list of snapshot schedules that define the frequency of
snapshot creation for the associated file systems and the retention period of snapshots taken on schedule.
For more information, see Snapshot Scheduling.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
Inherited Members
Namespace: Oci.FilestorageService.Models
Assembly: OCI.DotNetSDK.Filestorage.dll
Syntax
public class FilesystemSnapshotPolicy
Properties
AvailabilityDomain
Declaration
[Required(ErrorMessage = "AvailabilityDomain is required.")]
[JsonProperty(PropertyName = "availabilityDomain")]
public string AvailabilityDomain { get; set; }
Property Value
Type | Description |
---|---|
string | The availability domain that the file system snapshot policy is in. May be unset using a blank or NULL value.
|
Remarks
Required
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment that contains the file system snapshot policy. |
Remarks
Required
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. Example: {"Operations": {"CostCenter": "42"}} |
DisplayName
Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | A user-friendly name. It does not have to be unique, and it is 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. Example: {"Department": "Finance"} |
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the file system snapshot policy. |
Remarks
Required
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public FilesystemSnapshotPolicy.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
FilesystemSnapshotPolicy.LifecycleStateEnum? | The current state of the file system snapshot policy. |
Remarks
Required
PolicyPrefix
Declaration
[JsonProperty(PropertyName = "policyPrefix")]
public string PolicyPrefix { get; set; }
Property Value
Type | Description |
---|---|
string | The prefix to apply to all snapshots created by this policy.
|
Schedules
Declaration
[JsonProperty(PropertyName = "schedules")]
public List<SnapshotSchedule> Schedules { get; set; }
Property Value
Type | Description |
---|---|
List<SnapshotSchedule> | The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy. |
TimeCreated
Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the file system snapshot policy was created, expressed
in RFC 3339 timestamp format.
|
Remarks
Required