Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace 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](https://docs.cloud.oracle.com/iaas/Content/File/Tasks/snapshot-policies-and-schedules.htm).

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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

Properties

availabilityDomain

availabilityDomain: string

The availability domain that the file system snapshot policy is in. May be unset using a blank or NULL value.

Example: {@code Uocm:PHX-AD-2}

compartmentId

compartmentId: string

The OCID of the compartment that contains the file system snapshot policy.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Optional displayName

displayName: undefined | string

A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Example: {@code policy1}

Optional freeformTags

freeformTags: undefined | object

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: {@code {"Department": "Finance"}}

id

id: string

The OCID of the file system snapshot policy.

lifecycleState

lifecycleState: LifecycleState

The current state of the file system snapshot policy.

Optional policyPrefix

policyPrefix: undefined | string

The prefix to apply to all snapshots created by this policy.

Example: {@code acme}

Optional schedules

The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.

timeCreated

timeCreated: Date

The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format.

Example: {@code 2016-08-25T21:10:29.600Z}

Functions

getDeserializedJsonObj

getJsonObj