amazonka-storagegateway-1.6.1: Amazon Storage Gateway SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.StorageGateway.UpdateNFSFileShare

Contents

Description

Updates a file share. This operation is only supported in the file gateway type.

Updates the following file share setting:

  • Default storage class for your S3 bucket
  • Metadata defaults for your S3 bucket
  • Allowed NFS clients for your file share
  • Squash settings
  • Write status of your file share
Synopsis

Creating a Request

updateNFSFileShare Source #

Creates a value of UpdateNFSFileShare with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • unfsfsKMSKey - The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional.
  • unfsfsObjectACL - Sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
  • unfsfsKMSEncrypted - True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
  • unfsfsDefaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by a file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
  • unfsfsSquash - The user mapped to anonymous user. Valid options are the following: * RootSquash - Only root is mapped to anonymous user. * NoSquash - No one is mapped to anonymous user * AllSquash - Everyone is mapped to anonymous user.
  • unfsfsRequesterPays - Sets who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner, and otherwise to false.
  • unfsfsNFSFileShareDefaults - The default values for the file share. Optional.
  • unfsfsClientList - The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.
  • unfsfsGuessMIMETypeEnabled - Enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.
  • unfsfsReadOnly - Sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
  • unfsfsFileShareARN - The Amazon Resource Name (ARN) of the file share to be updated.

data UpdateNFSFileShare Source #

UpdateNFSFileShareInput

See: updateNFSFileShare smart constructor.

Instances
Eq UpdateNFSFileShare Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

Data UpdateNFSFileShare Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateNFSFileShare -> c UpdateNFSFileShare #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateNFSFileShare #

toConstr :: UpdateNFSFileShare -> Constr #

dataTypeOf :: UpdateNFSFileShare -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateNFSFileShare) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateNFSFileShare) #

gmapT :: (forall b. Data b => b -> b) -> UpdateNFSFileShare -> UpdateNFSFileShare #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateNFSFileShare -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateNFSFileShare -> r #

gmapQ :: (forall d. Data d => d -> u) -> UpdateNFSFileShare -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateNFSFileShare -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateNFSFileShare -> m UpdateNFSFileShare #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateNFSFileShare -> m UpdateNFSFileShare #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateNFSFileShare -> m UpdateNFSFileShare #

Read UpdateNFSFileShare Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

Show UpdateNFSFileShare Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

Generic UpdateNFSFileShare Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

Associated Types

type Rep UpdateNFSFileShare :: Type -> Type #

Hashable UpdateNFSFileShare Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

ToJSON UpdateNFSFileShare Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

AWSRequest UpdateNFSFileShare Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

Associated Types

type Rs UpdateNFSFileShare :: Type #

ToHeaders UpdateNFSFileShare Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

ToPath UpdateNFSFileShare Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

ToQuery UpdateNFSFileShare Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

NFData UpdateNFSFileShare Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

Methods

rnf :: UpdateNFSFileShare -> () #

type Rep UpdateNFSFileShare Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

type Rep UpdateNFSFileShare = D1 (MetaData "UpdateNFSFileShare" "Network.AWS.StorageGateway.UpdateNFSFileShare" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "UpdateNFSFileShare'" PrefixI True) (((S1 (MetaSel (Just "_unfsfsKMSKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_unfsfsObjectACL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ObjectACL))) :*: (S1 (MetaSel (Just "_unfsfsKMSEncrypted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_unfsfsDefaultStorageClass") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_unfsfsSquash") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_unfsfsRequesterPays") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_unfsfsNFSFileShareDefaults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe NFSFileShareDefaults)) :*: S1 (MetaSel (Just "_unfsfsClientList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 Text))))) :*: (S1 (MetaSel (Just "_unfsfsGuessMIMETypeEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_unfsfsReadOnly") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_unfsfsFileShareARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs UpdateNFSFileShare Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

Request Lenses

unfsfsKMSKey :: Lens' UpdateNFSFileShare (Maybe Text) Source #

The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional.

unfsfsObjectACL :: Lens' UpdateNFSFileShare (Maybe ObjectACL) Source #

Sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

unfsfsKMSEncrypted :: Lens' UpdateNFSFileShare (Maybe Bool) Source #

True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

unfsfsDefaultStorageClass :: Lens' UpdateNFSFileShare (Maybe Text) Source #

The default storage class for objects put into an Amazon S3 bucket by a file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

unfsfsSquash :: Lens' UpdateNFSFileShare (Maybe Text) Source #

The user mapped to anonymous user. Valid options are the following: * RootSquash - Only root is mapped to anonymous user. * NoSquash - No one is mapped to anonymous user * AllSquash - Everyone is mapped to anonymous user.

unfsfsRequesterPays :: Lens' UpdateNFSFileShare (Maybe Bool) Source #

Sets who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner, and otherwise to false.

unfsfsNFSFileShareDefaults :: Lens' UpdateNFSFileShare (Maybe NFSFileShareDefaults) Source #

The default values for the file share. Optional.

unfsfsClientList :: Lens' UpdateNFSFileShare (Maybe (NonEmpty Text)) Source #

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

unfsfsGuessMIMETypeEnabled :: Lens' UpdateNFSFileShare (Maybe Bool) Source #

Enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

unfsfsReadOnly :: Lens' UpdateNFSFileShare (Maybe Bool) Source #

Sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

unfsfsFileShareARN :: Lens' UpdateNFSFileShare Text Source #

The Amazon Resource Name (ARN) of the file share to be updated.

Destructuring the Response

updateNFSFileShareResponse Source #

Creates a value of UpdateNFSFileShareResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data UpdateNFSFileShareResponse Source #

UpdateNFSFileShareOutput

See: updateNFSFileShareResponse smart constructor.

Instances
Eq UpdateNFSFileShareResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

Data UpdateNFSFileShareResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateNFSFileShareResponse -> c UpdateNFSFileShareResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateNFSFileShareResponse #

toConstr :: UpdateNFSFileShareResponse -> Constr #

dataTypeOf :: UpdateNFSFileShareResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateNFSFileShareResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateNFSFileShareResponse) #

gmapT :: (forall b. Data b => b -> b) -> UpdateNFSFileShareResponse -> UpdateNFSFileShareResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateNFSFileShareResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateNFSFileShareResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> UpdateNFSFileShareResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateNFSFileShareResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateNFSFileShareResponse -> m UpdateNFSFileShareResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateNFSFileShareResponse -> m UpdateNFSFileShareResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateNFSFileShareResponse -> m UpdateNFSFileShareResponse #

Read UpdateNFSFileShareResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

Show UpdateNFSFileShareResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

Generic UpdateNFSFileShareResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

Associated Types

type Rep UpdateNFSFileShareResponse :: Type -> Type #

NFData UpdateNFSFileShareResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

type Rep UpdateNFSFileShareResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.UpdateNFSFileShare

type Rep UpdateNFSFileShareResponse = D1 (MetaData "UpdateNFSFileShareResponse" "Network.AWS.StorageGateway.UpdateNFSFileShare" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "UpdateNFSFileShareResponse'" PrefixI True) (S1 (MetaSel (Just "_unfsfsrsFileShareARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_unfsfsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

unfsfsrsFileShareARN :: Lens' UpdateNFSFileShareResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the updated file share.