amazonka-efs-2.0: Amazon Elastic File System SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EFS.PutFileSystemPolicy

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.

Synopsis

Creating a Request

data PutFileSystemPolicy Source #

See: newPutFileSystemPolicy smart constructor.

Constructors

PutFileSystemPolicy' 

Fields

  • bypassPolicyLockoutSafetyCheck :: Maybe Bool

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

  • fileSystemId :: Text

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

  • policy :: Text

    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.

Instances

Instances details
ToJSON PutFileSystemPolicy Source # 
Instance details

Defined in Amazonka.EFS.PutFileSystemPolicy

Methods

toJSON :: PutFileSystemPolicy -> Value #

toEncoding :: PutFileSystemPolicy -> Encoding #

toJSONList :: [PutFileSystemPolicy] -> Value #

toEncodingList :: [PutFileSystemPolicy] -> Encoding #

ToHeaders PutFileSystemPolicy Source # 
Instance details

Defined in Amazonka.EFS.PutFileSystemPolicy

Methods

toHeaders :: PutFileSystemPolicy -> [Header] #

ToPath PutFileSystemPolicy Source # 
Instance details

Defined in Amazonka.EFS.PutFileSystemPolicy

Methods

toPath :: PutFileSystemPolicy -> ByteString #

ToQuery PutFileSystemPolicy Source # 
Instance details

Defined in Amazonka.EFS.PutFileSystemPolicy

Methods

toQuery :: PutFileSystemPolicy -> QueryString #

AWSRequest PutFileSystemPolicy Source # 
Instance details

Defined in Amazonka.EFS.PutFileSystemPolicy

Associated Types

type AWSResponse PutFileSystemPolicy #

Methods

request :: (Service -> Service) -> PutFileSystemPolicy -> Request PutFileSystemPolicy #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutFileSystemPolicy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutFileSystemPolicy))) #

Generic PutFileSystemPolicy Source # 
Instance details

Defined in Amazonka.EFS.PutFileSystemPolicy

Associated Types

type Rep PutFileSystemPolicy :: Type -> Type #

Methods

from :: PutFileSystemPolicy -> Rep PutFileSystemPolicy x #

to :: Rep PutFileSystemPolicy x -> PutFileSystemPolicy #

Read PutFileSystemPolicy Source # 
Instance details

Defined in Amazonka.EFS.PutFileSystemPolicy

Methods

readsPrec :: Int -> ReadS PutFileSystemPolicy #

readList :: ReadS [PutFileSystemPolicy] #

readPrec :: ReadPrec PutFileSystemPolicy #

readListPrec :: ReadPrec [PutFileSystemPolicy] #

Show PutFileSystemPolicy Source # 
Instance details

Defined in Amazonka.EFS.PutFileSystemPolicy

Methods

showsPrec :: Int -> PutFileSystemPolicy -> ShowS #

show :: PutFileSystemPolicy -> String #

showList :: [PutFileSystemPolicy] -> ShowS #

NFData PutFileSystemPolicy Source # 
Instance details

Defined in Amazonka.EFS.PutFileSystemPolicy

Methods

rnf :: PutFileSystemPolicy -> () #

Eq PutFileSystemPolicy Source # 
Instance details

Defined in Amazonka.EFS.PutFileSystemPolicy

Methods

(==) :: PutFileSystemPolicy -> PutFileSystemPolicy -> Bool #

(/=) :: PutFileSystemPolicy -> PutFileSystemPolicy -> Bool #

Hashable PutFileSystemPolicy Source # 
Instance details

Defined in Amazonka.EFS.PutFileSystemPolicy

Methods

hashWithSalt :: Int -> PutFileSystemPolicy -> Int #

hash :: PutFileSystemPolicy -> Int #

type AWSResponse PutFileSystemPolicy Source # 
Instance details

Defined in Amazonka.EFS.PutFileSystemPolicy

type AWSResponse PutFileSystemPolicy = FileSystemPolicyDescription
type Rep PutFileSystemPolicy Source # 
Instance details

Defined in Amazonka.EFS.PutFileSystemPolicy

type Rep PutFileSystemPolicy = D1 ('MetaData "PutFileSystemPolicy" "Amazonka.EFS.PutFileSystemPolicy" "amazonka-efs-2.0-EHRjUBbcNxzHWDmYi0HAD5" 'False) (C1 ('MetaCons "PutFileSystemPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bypassPolicyLockoutSafetyCheck") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newPutFileSystemPolicy Source #

Arguments

:: Text

PutFileSystemPolicy

-> Text

PutFileSystemPolicy

-> PutFileSystemPolicy 

Create a value of PutFileSystemPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:bypassPolicyLockoutSafetyCheck:PutFileSystemPolicy', putFileSystemPolicy_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.

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

PutFileSystemPolicy, putFileSystemPolicy_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 EFS Resource-based Policies.

Request Lenses

putFileSystemPolicy_bypassPolicyLockoutSafetyCheck :: Lens' PutFileSystemPolicy (Maybe Bool) Source #

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

putFileSystemPolicy_fileSystemId :: Lens' PutFileSystemPolicy Text Source #

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

putFileSystemPolicy_policy :: Lens' PutFileSystemPolicy Text Source #

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.

Destructuring the Response

data FileSystemPolicyDescription Source #

See: newFileSystemPolicyDescription smart constructor.

Constructors

FileSystemPolicyDescription' 

Fields

Instances

Instances details
FromJSON FileSystemPolicyDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.FileSystemPolicyDescription

Methods

parseJSON :: Value -> Parser FileSystemPolicyDescription #

parseJSONList :: Value -> Parser [FileSystemPolicyDescription] #

Generic FileSystemPolicyDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.FileSystemPolicyDescription

Associated Types

type Rep FileSystemPolicyDescription :: Type -> Type #

Methods

from :: FileSystemPolicyDescription -> Rep FileSystemPolicyDescription x #

to :: Rep FileSystemPolicyDescription x -> FileSystemPolicyDescription #

Read FileSystemPolicyDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.FileSystemPolicyDescription

Methods

readsPrec :: Int -> ReadS FileSystemPolicyDescription #

readList :: ReadS [FileSystemPolicyDescription] #

readPrec :: ReadPrec FileSystemPolicyDescription #

readListPrec :: ReadPrec [FileSystemPolicyDescription] #

Show FileSystemPolicyDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.FileSystemPolicyDescription

Methods

showsPrec :: Int -> FileSystemPolicyDescription -> ShowS #

show :: FileSystemPolicyDescription -> String #

showList :: [FileSystemPolicyDescription] -> ShowS #

NFData FileSystemPolicyDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.FileSystemPolicyDescription

Methods

rnf :: FileSystemPolicyDescription -> () #

Eq FileSystemPolicyDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.FileSystemPolicyDescription

Methods

(==) :: FileSystemPolicyDescription -> FileSystemPolicyDescription -> Bool #

(/=) :: FileSystemPolicyDescription -> FileSystemPolicyDescription -> Bool #

Hashable FileSystemPolicyDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.FileSystemPolicyDescription

Methods

hashWithSalt :: Int -> FileSystemPolicyDescription -> Int #

hash :: FileSystemPolicyDescription -> Int #

type Rep FileSystemPolicyDescription Source # 
Instance details

Defined in Amazonka.EFS.Types.FileSystemPolicyDescription

type Rep FileSystemPolicyDescription = D1 ('MetaData "FileSystemPolicyDescription" "Amazonka.EFS.Types.FileSystemPolicyDescription" "amazonka-efs-2.0-EHRjUBbcNxzHWDmYi0HAD5" 'False) (C1 ('MetaCons "FileSystemPolicyDescription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newFileSystemPolicyDescription :: FileSystemPolicyDescription Source #

Create a value of FileSystemPolicyDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fileSystemId:FileSystemPolicyDescription', fileSystemPolicyDescription_fileSystemId - Specifies the EFS file system to which the FileSystemPolicy applies.

$sel:policy:FileSystemPolicyDescription', fileSystemPolicyDescription_policy - The JSON formatted FileSystemPolicy for the EFS file system.

Response Lenses

fileSystemPolicyDescription_fileSystemId :: Lens' FileSystemPolicyDescription (Maybe Text) Source #

Specifies the EFS file system to which the FileSystemPolicy applies.

fileSystemPolicyDescription_policy :: Lens' FileSystemPolicyDescription (Maybe Text) Source #

The JSON formatted FileSystemPolicy for the EFS file system.