CreateFilesystemSnapshotPolicyDetails¶

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

Bases: object

Details for creating the file system snapshot policy.

Methods

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

Attributes

`availability_domain`	[Required] Gets the availability_domain of this CreateFilesystemSnapshotPolicyDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateFilesystemSnapshotPolicyDetails.
`defined_tags`	Gets the defined_tags of this CreateFilesystemSnapshotPolicyDetails.
`display_name`	Gets the display_name of this CreateFilesystemSnapshotPolicyDetails.
`freeform_tags`	Gets the freeform_tags of this CreateFilesystemSnapshotPolicyDetails.
`policy_prefix`	Gets the policy_prefix of this CreateFilesystemSnapshotPolicyDetails.
`schedules`	Gets the schedules of this CreateFilesystemSnapshotPolicyDetails.

__init__(**kwargs)¶

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

Parameters:

availability_domain (str) – The value to assign to the availability_domain property of this CreateFilesystemSnapshotPolicyDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateFilesystemSnapshotPolicyDetails.
display_name (str) – The value to assign to the display_name property of this CreateFilesystemSnapshotPolicyDetails.
policy_prefix (str) – The value to assign to the policy_prefix property of this CreateFilesystemSnapshotPolicyDetails.
schedules (list[oci.file_storage.models.SnapshotSchedule]) – The value to assign to the schedules property of this CreateFilesystemSnapshotPolicyDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateFilesystemSnapshotPolicyDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateFilesystemSnapshotPolicyDetails.

availability_domain¶

[Required] Gets the availability_domain of this CreateFilesystemSnapshotPolicyDetails. The availability domain that the file system snapshot policy is in.

Example: Uocm:PHX-AD-1

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

compartment_id¶

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

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

defined_tags¶

Gets the defined_tags of this CreateFilesystemSnapshotPolicyDetails. 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 CreateFilesystemSnapshotPolicyDetails.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this CreateFilesystemSnapshotPolicyDetails. 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 CreateFilesystemSnapshotPolicyDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateFilesystemSnapshotPolicyDetails. 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 CreateFilesystemSnapshotPolicyDetails.
Return type:	dict(str, str)

policy_prefix¶

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

Example: acme

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

schedules¶

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

If using the CLI, provide the schedule as a list of JSON strings, with the list wrapped in quotation marks, i.e. ```

–schedules ‘[{“timeZone”:”UTC”,”period”:”DAILY”,”hourOfDay”:18},{“timeZone”:”UTC”,”period”:”HOURLY”}]’

```

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