Skip to content

PutFileSystemPolicyRequest

Source code in docs_src/capo_efs/types/put_file_system_policy_request.py
class PutFileSystemPolicyRequest(TypedDict, closed=True):
    file_system_id: "capo_efs.types.file_system_id.FileSystemId"
    """<p>The ID of the EFS file system that you want to create or update the <code>FileSystemPolicy</code> for.</p>"""
    policy: "capo_efs.types.policy.Policy"
    """<p>The <code>FileSystemPolicy</code> that you're creating. Accepts a JSON formatted policy definition. EFS file system policies have a 20,000 character limit. To find out more about the elements that make up a file system policy, see <a href="https://docs.aws.amazon.com/efs/latest/ug/security_iam_service-with-iam.html#security_iam_service-with-iam-resource-based-policies">Resource-based policies within Amazon EFS</a>. </p>"""
    bypass_policy_lockout_safety_check: "capo_efs.types.bypass_policy_lockout_safety_check.BypassPolicyLockoutSafetyCheck"
    """<p>(Optional) A boolean that specifies whether or not to bypass the <code>FileSystemPolicy</code> lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future <code>PutFileSystemPolicy</code> requests on this file system. Set <code>BypassPolicyLockoutSafetyCheck</code> to <code>True</code> only when you intend to prevent the IAM principal that is making the request from making subsequent <code>PutFileSystemPolicy</code> requests on this file system. The default value is <code>False</code>. </p>"""

bypass_policy_lockout_safety_check instance-attribute

bypass_policy_lockout_safety_check: BypassPolicyLockoutSafetyCheck

(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future PutFileSystemPolicy requests on this file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy requests on this file system. The default value is False.

file_system_id instance-attribute

file_system_id: FileSystemId

The ID of the EFS file system that you want to create or update the FileSystemPolicy for.

policy instance-attribute

policy: Policy

The FileSystemPolicy that you're creating. Accepts a JSON formatted policy definition. EFS file system policies have a 20,000 character limit. To find out more about the elements that make up a file system policy, see Resource-based policies within Amazon EFS.