FilesystemSnapshotPolicy¶

class oci.file_storage.models.FilesystemSnapshotPolicy(**kwargs)¶

Bases: object

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.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicy.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicy.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicy.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicy.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicy.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicy.
`availability_domain`	[Required] Gets the availability_domain of this FilesystemSnapshotPolicy.
`compartment_id`	[Required] Gets the compartment_id of this FilesystemSnapshotPolicy.
`defined_tags`	Gets the defined_tags of this FilesystemSnapshotPolicy.
`display_name`	Gets the display_name of this FilesystemSnapshotPolicy.
`freeform_tags`	Gets the freeform_tags of this FilesystemSnapshotPolicy.
`id`	[Required] Gets the id of this FilesystemSnapshotPolicy.
`lifecycle_state`	[Required] Gets the lifecycle_state of this FilesystemSnapshotPolicy.
`locks`	Gets the locks of this FilesystemSnapshotPolicy.
`policy_prefix`	Gets the policy_prefix of this FilesystemSnapshotPolicy.
`schedules`	Gets the schedules of this FilesystemSnapshotPolicy.
`time_created`	[Required] Gets the time_created of this FilesystemSnapshotPolicy.

Methods

__init__(**kwargs) Initializes a new FilesystemSnapshotPolicy object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicy. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicy. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicy. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicy. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicy. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a FilesystemSnapshotPolicy. This constant has a value of “INACTIVE”

__init__(**kwargs)¶

Initializes a new FilesystemSnapshotPolicy object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this FilesystemSnapshotPolicy.
availability_domain (str) – The value to assign to the availability_domain property of this FilesystemSnapshotPolicy.
id (str) – The value to assign to the id property of this FilesystemSnapshotPolicy.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this FilesystemSnapshotPolicy. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “INACTIVE”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this FilesystemSnapshotPolicy.
display_name (str) – The value to assign to the display_name property of this FilesystemSnapshotPolicy.
policy_prefix (str) – The value to assign to the policy_prefix property of this FilesystemSnapshotPolicy.
schedules (list[oci.file_storage.models.SnapshotSchedule]) – The value to assign to the schedules property of this FilesystemSnapshotPolicy.
locks (list[oci.file_storage.models.ResourceLock]) – The value to assign to the locks property of this FilesystemSnapshotPolicy.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this FilesystemSnapshotPolicy.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this FilesystemSnapshotPolicy.

availability_domain¶

[Required] Gets the availability_domain of this FilesystemSnapshotPolicy. The availability domain that the file system snapshot policy is in. May be unset using a blank or NULL value.

Example: Uocm:PHX-AD-2

Returns:	The availability_domain of this FilesystemSnapshotPolicy.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this FilesystemSnapshotPolicy. The OCID of the compartment that contains the file system snapshot policy.

Returns:	The compartment_id of this FilesystemSnapshotPolicy.
Return type:	str

defined_tags¶

Gets the defined_tags of this FilesystemSnapshotPolicy. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this FilesystemSnapshotPolicy.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this FilesystemSnapshotPolicy. A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Example: policy1

Returns:	The display_name of this FilesystemSnapshotPolicy.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this FilesystemSnapshotPolicy. 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”}

Returns:	The freeform_tags of this FilesystemSnapshotPolicy.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this FilesystemSnapshotPolicy. The OCID of the file system snapshot policy.

Returns:	The id of this FilesystemSnapshotPolicy.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this FilesystemSnapshotPolicy. The current state of the file system snapshot policy.

Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “INACTIVE”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this FilesystemSnapshotPolicy.
Return type:	str

locks¶

Gets the locks of this FilesystemSnapshotPolicy. Locks associated with this resource.

Returns:	The locks of this FilesystemSnapshotPolicy.
Return type:	list[oci.file_storage.models.ResourceLock]

policy_prefix¶

Gets the policy_prefix of this FilesystemSnapshotPolicy. The prefix to apply to all snapshots created by this policy.

Example: acme

Returns:	The policy_prefix of this FilesystemSnapshotPolicy.
Return type:	str

schedules¶

Gets the schedules of this FilesystemSnapshotPolicy. The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.

Returns:	The schedules of this FilesystemSnapshotPolicy.
Return type:	list[oci.file_storage.models.SnapshotSchedule]

time_created¶

[Required] Gets the time_created of this FilesystemSnapshotPolicy. The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this FilesystemSnapshotPolicy.
Return type:	datetime