CreateFileSystemDetails¶
- class oci.file_storage.models.CreateFileSystemDetails(**kwargs)¶
Bases:
objectDetails for creating the file system.
Attributes:
A constant which can be used with the clone_attach_status property of a CreateFileSystemDetails.
A constant which can be used with the clone_attach_status property of a CreateFileSystemDetails.
Gets the are_quota_rules_enabled of this CreateFileSystemDetails.
[Required] Gets the availability_domain of this CreateFileSystemDetails.
Gets the clone_attach_status of this CreateFileSystemDetails.
[Required] Gets the compartment_id of this CreateFileSystemDetails.
Gets the defined_tags of this CreateFileSystemDetails.
Gets the display_name of this CreateFileSystemDetails.
Gets the filesystem_snapshot_policy_id of this CreateFileSystemDetails.
Gets the freeform_tags of this CreateFileSystemDetails. 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"}.
Gets the kms_key_id of this CreateFileSystemDetails.
Gets the locks of this CreateFileSystemDetails.
Gets the source_snapshot_id of this CreateFileSystemDetails.
Methods:
__init__(**kwargs)Initializes a new CreateFileSystemDetails object with values from keyword arguments.
- CLONE_ATTACH_STATUS_ATTACH = 'ATTACH'¶
A constant which can be used with the clone_attach_status property of a CreateFileSystemDetails. This constant has a value of “ATTACH”
- CLONE_ATTACH_STATUS_DETACH = 'DETACH'¶
A constant which can be used with the clone_attach_status property of a CreateFileSystemDetails. This constant has a value of “DETACH”
- __init__(**kwargs)¶
Initializes a new CreateFileSystemDetails 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 CreateFileSystemDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateFileSystemDetails.
display_name (str) – The value to assign to the display_name property of this CreateFileSystemDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateFileSystemDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateFileSystemDetails.
locks (list[oci.file_storage.models.ResourceLock]) – The value to assign to the locks property of this CreateFileSystemDetails.
kms_key_id (str) – The value to assign to the kms_key_id property of this CreateFileSystemDetails.
source_snapshot_id (str) – The value to assign to the source_snapshot_id property of this CreateFileSystemDetails.
clone_attach_status (str) – The value to assign to the clone_attach_status property of this CreateFileSystemDetails. Allowed values for this property are: “DETACH”, “ATTACH”
filesystem_snapshot_policy_id (str) – The value to assign to the filesystem_snapshot_policy_id property of this CreateFileSystemDetails.
are_quota_rules_enabled (bool) – The value to assign to the are_quota_rules_enabled property of this CreateFileSystemDetails.
- property are_quota_rules_enabled¶
Gets the are_quota_rules_enabled of this CreateFileSystemDetails. Specifies the enforcement of quota rules on the file system.
- Returns
The are_quota_rules_enabled of this CreateFileSystemDetails.
- Return type
bool
- property availability_domain¶
[Required] Gets the availability_domain of this CreateFileSystemDetails. The availability domain to create the file system in.
Example: Uocm:PHX-AD-1
- Returns
The availability_domain of this CreateFileSystemDetails.
- Return type
str
- property clone_attach_status¶
Gets the clone_attach_status of this CreateFileSystemDetails. Specifies whether the clone file system is attached to its parent file system. If the value is set to ‘DETACH’, then the file system will be created, which is deep copied from the snapshot specified by sourceSnapshotId, else will remain attached to its parent.
Allowed values for this property are: “DETACH”, “ATTACH”
- Returns
The clone_attach_status of this CreateFileSystemDetails.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this CreateFileSystemDetails. The `OCID`__ of the compartment to create the file system in.
- Returns
The compartment_id of this CreateFileSystemDetails.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CreateFileSystemDetails. 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 CreateFileSystemDetails.
- Return type
dict(str, dict(str, object))
- property display_name¶
Gets the display_name of this CreateFileSystemDetails. A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
Example: My file system
- Returns
The display_name of this CreateFileSystemDetails.
- Return type
str
- property filesystem_snapshot_policy_id¶
Gets the filesystem_snapshot_policy_id of this CreateFileSystemDetails. The `OCID`__ of the associated file system snapshot policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.
May be unset as a blank value.
- Returns
The filesystem_snapshot_policy_id of this CreateFileSystemDetails.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CreateFileSystemDetails. 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 CreateFileSystemDetails.
- Return type
dict(str, str)
- property kms_key_id¶
Gets the kms_key_id of this CreateFileSystemDetails. The `OCID`__ of the KMS key used to encrypt the encryption keys associated with this file system.
- Returns
The kms_key_id of this CreateFileSystemDetails.
- Return type
str
- property locks¶
Gets the locks of this CreateFileSystemDetails. Locks associated with this resource.
- Returns
The locks of this CreateFileSystemDetails.
- Return type
- property source_snapshot_id¶
Gets the source_snapshot_id of this CreateFileSystemDetails. The `OCID`__ of the snapshot used to create a cloned file system. See `Cloning a File System`__.
- Returns
The source_snapshot_id of this CreateFileSystemDetails.
- Return type
str