Network.AWS.StorageGateway.CreateNFSFileShare

Creates a file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a Network File System (NFS) interface. This operation is only supported in the file gateway type.

Important: File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the region you are creating your file gateway in. If AWS STS is not activated in the region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

File gateway does not support creating hard or symbolic links on a file share.

Creating a Request

createNFSFileShare

Arguments

:: Text

cnfsfsClientToken

-> Text

cnfsfsGatewayARN

-> Text

cnfsfsRole

-> Text

cnfsfsLocationARN

-> CreateNFSFileShare

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

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

• cnfsfsKMSKey - The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional.
• cnfsfsObjectACL - Sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is "private".
• cnfsfsKMSEncrypted - 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.
• cnfsfsDefaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by 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.
• cnfsfsSquash - Maps a user 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.
• cnfsfsRequesterPays - 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.
• cnfsfsNFSFileShareDefaults - File share default values. Optional.
• cnfsfsClientList - The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.
• cnfsfsGuessMIMETypeEnabled - 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.
• cnfsfsReadOnly - Sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
• cnfsfsClientToken - A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
• cnfsfsGatewayARN - The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
• cnfsfsRole - The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
• cnfsfsLocationARN - The ARN of the backed storage used for storing file data.

data CreateNFSFileShare

CreateNFSFileShareInput

See: createNFSFileShare smart constructor.

Instances

Eq CreateNFSFileShare

Methods

(==) :: CreateNFSFileShare -> CreateNFSFileShare -> Bool

(/=) :: CreateNFSFileShare -> CreateNFSFileShare -> Bool

Data CreateNFSFileShare

Methods

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

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

toConstr :: CreateNFSFileShare -> Constr

dataTypeOf :: CreateNFSFileShare -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateNFSFileShare)

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

gmapT :: (forall b. Data b => b -> b) -> CreateNFSFileShare -> CreateNFSFileShare

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

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

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

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

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

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

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

Read CreateNFSFileShare

Methods

readsPrec :: Int -> ReadS CreateNFSFileShare

readList :: ReadS [CreateNFSFileShare]

readPrec :: ReadPrec CreateNFSFileShare

readListPrec :: ReadPrec [CreateNFSFileShare]

Show CreateNFSFileShare

Methods

showsPrec :: Int -> CreateNFSFileShare -> ShowS

show :: CreateNFSFileShare -> String

showList :: [CreateNFSFileShare] -> ShowS

Generic CreateNFSFileShare

Associated Types

type Rep CreateNFSFileShare :: * -> *

Methods

from :: CreateNFSFileShare -> Rep CreateNFSFileShare x

to :: Rep CreateNFSFileShare x -> CreateNFSFileShare

Hashable CreateNFSFileShare

Methods

hashWithSalt :: Int -> CreateNFSFileShare -> Int

hash :: CreateNFSFileShare -> Int

ToJSON CreateNFSFileShare

Methods

toJSON :: CreateNFSFileShare -> Value

toEncoding :: CreateNFSFileShare -> Encoding

toJSONList :: [CreateNFSFileShare] -> Value

toEncodingList :: [CreateNFSFileShare] -> Encoding

NFData CreateNFSFileShare

Methods

rnf :: CreateNFSFileShare -> ()

AWSRequest CreateNFSFileShare

Associated Types

type Rs CreateNFSFileShare :: *

Methods

request :: CreateNFSFileShare -> Request CreateNFSFileShare

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateNFSFileShare -> ClientResponse -> m (Response CreateNFSFileShare)

ToHeaders CreateNFSFileShare

Methods

toHeaders :: CreateNFSFileShare -> [Header]

ToPath CreateNFSFileShare

Methods

toPath :: CreateNFSFileShare -> ByteString

ToQuery CreateNFSFileShare

Methods

toQuery :: CreateNFSFileShare -> QueryString

type Rep CreateNFSFileShare

type Rep CreateNFSFileShare = D1 * (MetaData "CreateNFSFileShare" "Network.AWS.StorageGateway.CreateNFSFileShare" "amazonka-storagegateway-1.6.0-4O2jykLIBNRAOy2n0S31Gg" False) (C1 * (MetaCons "CreateNFSFileShare'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cnfsfsKMSKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cnfsfsObjectACL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ObjectACL))) (S1 * (MetaSel (Just Symbol "_cnfsfsKMSEncrypted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cnfsfsDefaultStorageClass") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cnfsfsSquash") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cnfsfsRequesterPays") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_cnfsfsNFSFileShareDefaults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe NFSFileShareDefaults)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cnfsfsClientList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (List1 Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cnfsfsGuessMIMETypeEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_cnfsfsReadOnly") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cnfsfsClientToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cnfsfsGatewayARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cnfsfsRole") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cnfsfsLocationARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))))

type Rs CreateNFSFileShare

type Rs CreateNFSFileShare = CreateNFSFileShareResponse

Request Lenses

cnfsfsKMSKey :: Lens' CreateNFSFileShare (Maybe Text)

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

cnfsfsObjectACL :: Lens' CreateNFSFileShare (Maybe ObjectACL)

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

cnfsfsKMSEncrypted :: Lens' CreateNFSFileShare (Maybe Bool)

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.

cnfsfsDefaultStorageClass :: Lens' CreateNFSFileShare (Maybe Text)

The default storage class for objects put into an Amazon S3 bucket by 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.

cnfsfsSquash :: Lens' CreateNFSFileShare (Maybe Text)

Maps a user 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.

cnfsfsRequesterPays :: Lens' CreateNFSFileShare (Maybe Bool)

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.

cnfsfsNFSFileShareDefaults :: Lens' CreateNFSFileShare (Maybe NFSFileShareDefaults)

File share default values. Optional.

cnfsfsClientList :: Lens' CreateNFSFileShare (Maybe (NonEmpty Text))

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

cnfsfsGuessMIMETypeEnabled :: Lens' CreateNFSFileShare (Maybe Bool)

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.

cnfsfsReadOnly :: Lens' CreateNFSFileShare (Maybe Bool)

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

cnfsfsClientToken :: Lens' CreateNFSFileShare Text

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

cnfsfsGatewayARN :: Lens' CreateNFSFileShare Text

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

cnfsfsRole :: Lens' CreateNFSFileShare Text

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

cnfsfsLocationARN :: Lens' CreateNFSFileShare Text

The ARN of the backed storage used for storing file data.

Destructuring the Response

createNFSFileShareResponse

Arguments

:: Int

cnfsfsrsResponseStatus

-> CreateNFSFileShareResponse

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

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

• cnfsfsrsFileShareARN - The Amazon Resource Name (ARN) of the newly created file share.
• cnfsfsrsResponseStatus - -- | The response status code.

data CreateNFSFileShareResponse

CreateNFSFileShareOutput

See: createNFSFileShareResponse smart constructor.

Instances

Eq CreateNFSFileShareResponse

Methods

(==) :: CreateNFSFileShareResponse -> CreateNFSFileShareResponse -> Bool

(/=) :: CreateNFSFileShareResponse -> CreateNFSFileShareResponse -> Bool

Data CreateNFSFileShareResponse

Methods

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

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

toConstr :: CreateNFSFileShareResponse -> Constr

dataTypeOf :: CreateNFSFileShareResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateNFSFileShareResponse)

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

gmapT :: (forall b. Data b => b -> b) -> CreateNFSFileShareResponse -> CreateNFSFileShareResponse

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

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

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

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

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

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

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

Read CreateNFSFileShareResponse

Methods

readsPrec :: Int -> ReadS CreateNFSFileShareResponse

readList :: ReadS [CreateNFSFileShareResponse]

readPrec :: ReadPrec CreateNFSFileShareResponse

readListPrec :: ReadPrec [CreateNFSFileShareResponse]

Show CreateNFSFileShareResponse

Methods

showsPrec :: Int -> CreateNFSFileShareResponse -> ShowS

show :: CreateNFSFileShareResponse -> String

showList :: [CreateNFSFileShareResponse] -> ShowS

Generic CreateNFSFileShareResponse

Associated Types

type Rep CreateNFSFileShareResponse :: * -> *

Methods

from :: CreateNFSFileShareResponse -> Rep CreateNFSFileShareResponse x

to :: Rep CreateNFSFileShareResponse x -> CreateNFSFileShareResponse

NFData CreateNFSFileShareResponse

Methods

rnf :: CreateNFSFileShareResponse -> ()

type Rep CreateNFSFileShareResponse

type Rep CreateNFSFileShareResponse = D1 * (MetaData "CreateNFSFileShareResponse" "Network.AWS.StorageGateway.CreateNFSFileShare" "amazonka-storagegateway-1.6.0-4O2jykLIBNRAOy2n0S31Gg" False) (C1 * (MetaCons "CreateNFSFileShareResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cnfsfsrsFileShareARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cnfsfsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

cnfsfsrsFileShareARN :: Lens' CreateNFSFileShareResponse (Maybe Text)

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

cnfsfsrsResponseStatus :: Lens' CreateNFSFileShareResponse Int

• - | The response status code.