Class: Aws::EFS::Types::PutFileSystemPolicyRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb

Overview

Note:

When making an API call, you may pass PutFileSystemPolicyRequest data as a hash:

{
  file_system_id: "FileSystemId", # required
  policy: "Policy", # required
  bypass_policy_lockout_safety_check: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bypass_policy_lockout_safety_checkBoolean

(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.

Returns:

  • (Boolean)


2409
2410
2411
2412
2413
2414
2415
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 2409

class PutFileSystemPolicyRequest < Struct.new(
  :file_system_id,
  :policy,
  :bypass_policy_lockout_safety_check)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_idString

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

Returns:

  • (String)


2409
2410
2411
2412
2413
2414
2415
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 2409

class PutFileSystemPolicyRequest < Struct.new(
  :file_system_id,
  :policy,
  :bypass_policy_lockout_safety_check)
  SENSITIVE = []
  include Aws::Structure
end

#policyString

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.

Returns:

  • (String)


2409
2410
2411
2412
2413
2414
2415
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 2409

class PutFileSystemPolicyRequest < Struct.new(
  :file_system_id,
  :policy,
  :bypass_policy_lockout_safety_check)
  SENSITIVE = []
  include Aws::Structure
end