PUTFILESYSTEMPOLICY()`¶

About PutFileSystemPolicy¶

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.

Method Signature¶

METHODS /AWS1/IF_EFS~PUTFILESYSTEMPOLICY
  IMPORTING
    !IV_FILESYSTEMID TYPE /AWS1/EFSFILESYSTEMID OPTIONAL
    !IV_POLICY TYPE /AWS1/EFSPOLICY OPTIONAL
    !IV_BYPASSPLYLKOUTSAFETYCHECK TYPE /AWS1/EFSBYPASSPLYLKOUTSAFET00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_efsfilesystemplydesc
  RAISING
    /AWS1/CX_EFSBADREQUEST
    /AWS1/CX_EFSFILESYSTEMNOTFOUND
    /AWS1/CX_EFSINCORRECTFILESYS00
    /AWS1/CX_EFSINTERNALSERVERERR
    /AWS1/CX_EFSINVALIDPOLICYEX
    /AWS1/CX_EFSCLIENTEXC
    /AWS1/CX_EFSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_filesystemid` `TYPE /AWS1/EFSFILESYSTEMID` `/AWS1/EFSFILESYSTEMID`¶

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

`iv_policy` `TYPE /AWS1/EFSPOLICY` `/AWS1/EFSPOLICY`¶

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.

Optional arguments:¶

`iv_bypassplylkoutsafetycheck` `TYPE /AWS1/EFSBYPASSPLYLKOUTSAFET00` `/AWS1/EFSBYPASSPLYLKOUTSAFET00`¶

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

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_efsfilesystemplydesc` `/AWS1/CL_EFSFILESYSTEMPLYDESC`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->putfilesystempolicy(
  iv_bypassplylkoutsafetycheck = ABAP_TRUE
  iv_filesystemid = |string|
  iv_policy = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_filesystemid = lo_result->get_filesystemid( ).
  lv_policy = lo_result->get_policy( ).
ENDIF.

/AWS1/IF_EFS=>PUTFILESYSTEMPOLICY()¶