Skip to content

Put File System Policy

efs_put_file_system_policy R Documentation

Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system

Description

Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system. A file system policy is an IAM resource-based policy and can contain multiple policy statements. A file system always has exactly one file system policy, which can be the default policy or an explicit policy set or updated using this API operation. EFS file system policies have a 20,000 character limit. When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see Default EFS File System Policy.

EFS file system policies have a 20,000 character limit.

This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action.

Usage

efs_put_file_system_policy(FileSystemId, Policy,
  BypassPolicyLockoutSafetyCheck)

Arguments

FileSystemId

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

Policy

[required] 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 EFS Resource-based Policies.

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 put_file_system_policy 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 put_file_system_policy requests on this file system. The default value is False.

Value

A list with the following syntax: 

list(
  FileSystemId = "string",
  Policy = "string"
)

Request syntax

svc$put_file_system_policy(
  FileSystemId = "string",
  Policy = "string",
  BypassPolicyLockoutSafetyCheck = TRUE|FALSE
)