{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.StorageGateway.CreateSMBFileShare
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Creates a Server Message Block (SMB) file share on an existing S3 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 an SMB interface. This operation is only supported for S3 File
-- Gateways.
--
-- S3 File Gateways require Security Token Service (Amazon Web Services
-- STS) to be activated to enable you to create a file share. Make sure
-- that Amazon Web Services STS is activated in the Amazon Web Services
-- Region you are creating your S3 File Gateway in. If Amazon Web Services
-- STS is not activated in this Amazon Web Services Region, activate it.
-- For information about how to activate Amazon Web Services STS, see
-- <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region>
-- in the /Identity and Access Management User Guide/.
--
-- File gateways don\'t support creating hard or symbolic links on a file
-- share.
module Amazonka.StorageGateway.CreateSMBFileShare
  ( -- * Creating a Request
    CreateSMBFileShare (..),
    newCreateSMBFileShare,

    -- * Request Lenses
    createSMBFileShare_accessBasedEnumeration,
    createSMBFileShare_adminUserList,
    createSMBFileShare_auditDestinationARN,
    createSMBFileShare_authentication,
    createSMBFileShare_bucketRegion,
    createSMBFileShare_cacheAttributes,
    createSMBFileShare_caseSensitivity,
    createSMBFileShare_defaultStorageClass,
    createSMBFileShare_fileShareName,
    createSMBFileShare_guessMIMETypeEnabled,
    createSMBFileShare_invalidUserList,
    createSMBFileShare_kmsEncrypted,
    createSMBFileShare_kmsKey,
    createSMBFileShare_notificationPolicy,
    createSMBFileShare_objectACL,
    createSMBFileShare_oplocksEnabled,
    createSMBFileShare_readOnly,
    createSMBFileShare_requesterPays,
    createSMBFileShare_sMBACLEnabled,
    createSMBFileShare_tags,
    createSMBFileShare_vPCEndpointDNSName,
    createSMBFileShare_validUserList,
    createSMBFileShare_clientToken,
    createSMBFileShare_gatewayARN,
    createSMBFileShare_role,
    createSMBFileShare_locationARN,

    -- * Destructuring the Response
    CreateSMBFileShareResponse (..),
    newCreateSMBFileShareResponse,

    -- * Response Lenses
    createSMBFileShareResponse_fileShareARN,
    createSMBFileShareResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.StorageGateway.Types

-- | CreateSMBFileShareInput
--
-- /See:/ 'newCreateSMBFileShare' smart constructor.
data CreateSMBFileShare = CreateSMBFileShare'
  { -- | The files and folders on this share will only be visible to users with
    -- read access.
    CreateSMBFileShare -> Maybe Bool
accessBasedEnumeration :: Prelude.Maybe Prelude.Bool,
    -- | A list of users or groups in the Active Directory that will be granted
    -- administrator privileges on the file share. These users can do all file
    -- operations as the super-user. Acceptable formats include:
    -- @DOMAIN\\User1@, @user1@, @\@group1@, and @\@DOMAIN\\group1@.
    --
    -- Use this option very carefully, because any user in this list can do
    -- anything they like on the file share, regardless of file permissions.
    CreateSMBFileShare -> Maybe [Text]
adminUserList :: Prelude.Maybe [Prelude.Text],
    -- | The Amazon Resource Name (ARN) of the storage used for audit logs.
    CreateSMBFileShare -> Maybe Text
auditDestinationARN :: Prelude.Maybe Prelude.Text,
    -- | The authentication method that users use to access the file share. The
    -- default is @ActiveDirectory@.
    --
    -- Valid Values: @ActiveDirectory@ | @GuestAccess@
    CreateSMBFileShare -> Maybe Text
authentication :: Prelude.Maybe Prelude.Text,
    -- | Specifies the Region of the S3 bucket where the SMB file share stores
    -- files.
    --
    -- This parameter is required for SMB file shares that connect to Amazon S3
    -- through a VPC endpoint, a VPC access point, or an access point alias
    -- that points to a VPC access point.
    CreateSMBFileShare -> Maybe Text
bucketRegion :: Prelude.Maybe Prelude.Text,
    -- | Specifies refresh cache information for the file share.
    CreateSMBFileShare -> Maybe CacheAttributes
cacheAttributes :: Prelude.Maybe CacheAttributes,
    -- | The case of an object name in an Amazon S3 bucket. For
    -- @ClientSpecified@, the client determines the case sensitivity. For
    -- @CaseSensitive@, the gateway determines the case sensitivity. The
    -- default value is @ClientSpecified@.
    CreateSMBFileShare -> Maybe CaseSensitivity
caseSensitivity :: Prelude.Maybe CaseSensitivity,
    -- | The default storage class for objects put into an Amazon S3 bucket by
    -- the S3 File Gateway. The default value is @S3_STANDARD@. Optional.
    --
    -- Valid Values: @S3_STANDARD@ | @S3_INTELLIGENT_TIERING@ |
    -- @S3_STANDARD_IA@ | @S3_ONEZONE_IA@
    CreateSMBFileShare -> Maybe Text
defaultStorageClass :: Prelude.Maybe Prelude.Text,
    -- | The name of the file share. Optional.
    --
    -- @FileShareName@ must be set if an S3 prefix name is set in
    -- @LocationARN@, or if an access point or access point alias is used.
    CreateSMBFileShare -> Maybe Text
fileShareName :: Prelude.Maybe Prelude.Text,
    -- | A value that enables guessing of the MIME type for uploaded objects
    -- based on file extensions. Set this value to @true@ to enable MIME type
    -- guessing, otherwise set to @false@. The default value is @true@.
    --
    -- Valid Values: @true@ | @false@
    CreateSMBFileShare -> Maybe Bool
guessMIMETypeEnabled :: Prelude.Maybe Prelude.Bool,
    -- | A list of users or groups in the Active Directory that are not allowed
    -- to access the file share. A group must be prefixed with the \@
    -- character. Acceptable formats include: @DOMAIN\\User1@, @user1@,
    -- @\@group1@, and @\@DOMAIN\\group1@. Can only be set if Authentication is
    -- set to @ActiveDirectory@.
    CreateSMBFileShare -> Maybe [Text]
invalidUserList :: Prelude.Maybe [Prelude.Text],
    -- | Set to @true@ to use Amazon S3 server-side encryption with your own KMS
    -- key, or @false@ to use a key managed by Amazon S3. Optional.
    --
    -- Valid Values: @true@ | @false@
    CreateSMBFileShare -> Maybe Bool
kmsEncrypted :: Prelude.Maybe Prelude.Bool,
    -- | The Amazon Resource Name (ARN) of a symmetric customer master key (CMK)
    -- used for Amazon S3 server-side encryption. Storage Gateway does not
    -- support asymmetric CMKs. This value can only be set when @KMSEncrypted@
    -- is @true@. Optional.
    CreateSMBFileShare -> Maybe Text
kmsKey :: Prelude.Maybe Prelude.Text,
    -- | The notification policy of the file share. @SettlingTimeInSeconds@
    -- controls the number of seconds to wait after the last point in time a
    -- client wrote to a file before generating an @ObjectUploaded@
    -- notification. Because clients can make many small writes to files, it\'s
    -- best to set this parameter for as long as possible to avoid generating
    -- multiple notifications for the same file in a small time period.
    --
    -- @SettlingTimeInSeconds@ has no effect on the timing of the object
    -- uploading to Amazon S3, only the timing of the notification.
    --
    -- The following example sets @NotificationPolicy@ on with
    -- @SettlingTimeInSeconds@ set to 60.
    --
    -- @{\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}@
    --
    -- The following example sets @NotificationPolicy@ off.
    --
    -- @{}@
    CreateSMBFileShare -> Maybe Text
notificationPolicy :: Prelude.Maybe Prelude.Text,
    -- | A value that sets the access control list (ACL) permission for objects
    -- in the S3 bucket that a S3 File Gateway puts objects into. The default
    -- value is @private@.
    CreateSMBFileShare -> Maybe ObjectACL
objectACL :: Prelude.Maybe ObjectACL,
    -- | Specifies whether opportunistic locking is enabled for the SMB file
    -- share.
    --
    -- Enabling opportunistic locking on case-sensitive shares is not
    -- recommended for workloads that involve access to files with the same
    -- name in different case.
    --
    -- Valid Values: @true@ | @false@
    CreateSMBFileShare -> Maybe Bool
oplocksEnabled :: Prelude.Maybe Prelude.Bool,
    -- | A value that sets the write status of a file share. Set this value to
    -- @true@ to set the write status to read-only, otherwise set to @false@.
    --
    -- Valid Values: @true@ | @false@
    CreateSMBFileShare -> Maybe Bool
readOnly :: Prelude.Maybe Prelude.Bool,
    -- | A value that sets who pays the cost of the request and the cost
    -- associated with data download from the S3 bucket. If this value is set
    -- to @true@, the requester pays the costs; otherwise, the S3 bucket owner
    -- pays. However, the S3 bucket owner always pays the cost of storing data.
    --
    -- @RequesterPays@ is a configuration for the S3 bucket that backs the file
    -- share, so make sure that the configuration on the file share is the same
    -- as the S3 bucket configuration.
    --
    -- Valid Values: @true@ | @false@
    CreateSMBFileShare -> Maybe Bool
requesterPays :: Prelude.Maybe Prelude.Bool,
    -- | Set this value to @true@ to enable access control list (ACL) on the SMB
    -- file share. Set it to @false@ to map file and directory permissions to
    -- the POSIX permissions.
    --
    -- For more information, see
    -- <https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html Using Microsoft Windows ACLs to control access to an SMB file share>
    -- in the /Storage Gateway User Guide/.
    --
    -- Valid Values: @true@ | @false@
    CreateSMBFileShare -> Maybe Bool
sMBACLEnabled :: Prelude.Maybe Prelude.Bool,
    -- | A list of up to 50 tags that can be assigned to the NFS file share. Each
    -- tag is a key-value pair.
    --
    -- Valid characters for key and value are letters, spaces, and numbers
    -- representable in UTF-8 format, and the following special characters: + -
    -- = . _ : \/ \@. The maximum length of a tag\'s key is 128 characters, and
    -- the maximum length for a tag\'s value is 256.
    CreateSMBFileShare -> Maybe [Tag]
tags :: Prelude.Maybe [Tag],
    -- | Specifies the DNS name for the VPC endpoint that the SMB file share uses
    -- to connect to Amazon S3.
    --
    -- This parameter is required for SMB file shares that connect to Amazon S3
    -- through a VPC endpoint, a VPC access point, or an access point alias
    -- that points to a VPC access point.
    CreateSMBFileShare -> Maybe Text
vPCEndpointDNSName :: Prelude.Maybe Prelude.Text,
    -- | A list of users or groups in the Active Directory that are allowed to
    -- access the file < > share. A group must be prefixed with the \@
    -- character. Acceptable formats include: @DOMAIN\\User1@, @user1@,
    -- @\@group1@, and @\@DOMAIN\\group1@. Can only be set if Authentication is
    -- set to @ActiveDirectory@.
    CreateSMBFileShare -> Maybe [Text]
validUserList :: Prelude.Maybe [Prelude.Text],
    -- | A unique string value that you supply that is used by S3 File Gateway to
    -- ensure idempotent file share creation.
    CreateSMBFileShare -> Text
clientToken :: Prelude.Text,
    -- | The ARN of the S3 File Gateway on which you want to create a file share.
    CreateSMBFileShare -> Text
gatewayARN :: Prelude.Text,
    -- | The ARN of the Identity and Access Management (IAM) role that an S3 File
    -- Gateway assumes when it accesses the underlying storage.
    CreateSMBFileShare -> Text
role' :: Prelude.Text,
    -- | A custom ARN for the backend storage used for storing data for file
    -- shares. It includes a resource ARN with an optional prefix
    -- concatenation. The prefix must end with a forward slash (\/).
    --
    -- You can specify LocationARN as a bucket ARN, access point ARN or access
    -- point alias, as shown in the following examples.
    --
    -- Bucket ARN:
    --
    -- @arn:aws:s3:::my-bucket\/prefix\/@
    --
    -- Access point ARN:
    --
    -- @arn:aws:s3:region:account-id:accesspoint\/access-point-name\/prefix\/@
    --
    -- If you specify an access point, the bucket policy must be configured to
    -- delegate access control to the access point. For information, see
    -- <https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control Delegating access control to access points>
    -- in the /Amazon S3 User Guide/.
    --
    -- Access point alias:
    --
    -- @test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias@
    CreateSMBFileShare -> Text
locationARN :: Prelude.Text
  }
  deriving (CreateSMBFileShare -> CreateSMBFileShare -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CreateSMBFileShare -> CreateSMBFileShare -> Bool
$c/= :: CreateSMBFileShare -> CreateSMBFileShare -> Bool
== :: CreateSMBFileShare -> CreateSMBFileShare -> Bool
$c== :: CreateSMBFileShare -> CreateSMBFileShare -> Bool
Prelude.Eq, ReadPrec [CreateSMBFileShare]
ReadPrec CreateSMBFileShare
Int -> ReadS CreateSMBFileShare
ReadS [CreateSMBFileShare]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CreateSMBFileShare]
$creadListPrec :: ReadPrec [CreateSMBFileShare]
readPrec :: ReadPrec CreateSMBFileShare
$creadPrec :: ReadPrec CreateSMBFileShare
readList :: ReadS [CreateSMBFileShare]
$creadList :: ReadS [CreateSMBFileShare]
readsPrec :: Int -> ReadS CreateSMBFileShare
$creadsPrec :: Int -> ReadS CreateSMBFileShare
Prelude.Read, Int -> CreateSMBFileShare -> ShowS
[CreateSMBFileShare] -> ShowS
CreateSMBFileShare -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CreateSMBFileShare] -> ShowS
$cshowList :: [CreateSMBFileShare] -> ShowS
show :: CreateSMBFileShare -> String
$cshow :: CreateSMBFileShare -> String
showsPrec :: Int -> CreateSMBFileShare -> ShowS
$cshowsPrec :: Int -> CreateSMBFileShare -> ShowS
Prelude.Show, forall x. Rep CreateSMBFileShare x -> CreateSMBFileShare
forall x. CreateSMBFileShare -> Rep CreateSMBFileShare x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep CreateSMBFileShare x -> CreateSMBFileShare
$cfrom :: forall x. CreateSMBFileShare -> Rep CreateSMBFileShare x
Prelude.Generic)

-- |
-- Create a value of 'CreateSMBFileShare' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'accessBasedEnumeration', 'createSMBFileShare_accessBasedEnumeration' - The files and folders on this share will only be visible to users with
-- read access.
--
-- 'adminUserList', 'createSMBFileShare_adminUserList' - A list of users or groups in the Active Directory that will be granted
-- administrator privileges on the file share. These users can do all file
-- operations as the super-user. Acceptable formats include:
-- @DOMAIN\\User1@, @user1@, @\@group1@, and @\@DOMAIN\\group1@.
--
-- Use this option very carefully, because any user in this list can do
-- anything they like on the file share, regardless of file permissions.
--
-- 'auditDestinationARN', 'createSMBFileShare_auditDestinationARN' - The Amazon Resource Name (ARN) of the storage used for audit logs.
--
-- 'authentication', 'createSMBFileShare_authentication' - The authentication method that users use to access the file share. The
-- default is @ActiveDirectory@.
--
-- Valid Values: @ActiveDirectory@ | @GuestAccess@
--
-- 'bucketRegion', 'createSMBFileShare_bucketRegion' - Specifies the Region of the S3 bucket where the SMB file share stores
-- files.
--
-- This parameter is required for SMB file shares that connect to Amazon S3
-- through a VPC endpoint, a VPC access point, or an access point alias
-- that points to a VPC access point.
--
-- 'cacheAttributes', 'createSMBFileShare_cacheAttributes' - Specifies refresh cache information for the file share.
--
-- 'caseSensitivity', 'createSMBFileShare_caseSensitivity' - The case of an object name in an Amazon S3 bucket. For
-- @ClientSpecified@, the client determines the case sensitivity. For
-- @CaseSensitive@, the gateway determines the case sensitivity. The
-- default value is @ClientSpecified@.
--
-- 'defaultStorageClass', 'createSMBFileShare_defaultStorageClass' - The default storage class for objects put into an Amazon S3 bucket by
-- the S3 File Gateway. The default value is @S3_STANDARD@. Optional.
--
-- Valid Values: @S3_STANDARD@ | @S3_INTELLIGENT_TIERING@ |
-- @S3_STANDARD_IA@ | @S3_ONEZONE_IA@
--
-- 'fileShareName', 'createSMBFileShare_fileShareName' - The name of the file share. Optional.
--
-- @FileShareName@ must be set if an S3 prefix name is set in
-- @LocationARN@, or if an access point or access point alias is used.
--
-- 'guessMIMETypeEnabled', 'createSMBFileShare_guessMIMETypeEnabled' - A value that enables guessing of the MIME type for uploaded objects
-- based on file extensions. Set this value to @true@ to enable MIME type
-- guessing, otherwise set to @false@. The default value is @true@.
--
-- Valid Values: @true@ | @false@
--
-- 'invalidUserList', 'createSMBFileShare_invalidUserList' - A list of users or groups in the Active Directory that are not allowed
-- to access the file share. A group must be prefixed with the \@
-- character. Acceptable formats include: @DOMAIN\\User1@, @user1@,
-- @\@group1@, and @\@DOMAIN\\group1@. Can only be set if Authentication is
-- set to @ActiveDirectory@.
--
-- 'kmsEncrypted', 'createSMBFileShare_kmsEncrypted' - Set to @true@ to use Amazon S3 server-side encryption with your own KMS
-- key, or @false@ to use a key managed by Amazon S3. Optional.
--
-- Valid Values: @true@ | @false@
--
-- 'kmsKey', 'createSMBFileShare_kmsKey' - The Amazon Resource Name (ARN) of a symmetric customer master key (CMK)
-- used for Amazon S3 server-side encryption. Storage Gateway does not
-- support asymmetric CMKs. This value can only be set when @KMSEncrypted@
-- is @true@. Optional.
--
-- 'notificationPolicy', 'createSMBFileShare_notificationPolicy' - The notification policy of the file share. @SettlingTimeInSeconds@
-- controls the number of seconds to wait after the last point in time a
-- client wrote to a file before generating an @ObjectUploaded@
-- notification. Because clients can make many small writes to files, it\'s
-- best to set this parameter for as long as possible to avoid generating
-- multiple notifications for the same file in a small time period.
--
-- @SettlingTimeInSeconds@ has no effect on the timing of the object
-- uploading to Amazon S3, only the timing of the notification.
--
-- The following example sets @NotificationPolicy@ on with
-- @SettlingTimeInSeconds@ set to 60.
--
-- @{\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}@
--
-- The following example sets @NotificationPolicy@ off.
--
-- @{}@
--
-- 'objectACL', 'createSMBFileShare_objectACL' - A value that sets the access control list (ACL) permission for objects
-- in the S3 bucket that a S3 File Gateway puts objects into. The default
-- value is @private@.
--
-- 'oplocksEnabled', 'createSMBFileShare_oplocksEnabled' - Specifies whether opportunistic locking is enabled for the SMB file
-- share.
--
-- Enabling opportunistic locking on case-sensitive shares is not
-- recommended for workloads that involve access to files with the same
-- name in different case.
--
-- Valid Values: @true@ | @false@
--
-- 'readOnly', 'createSMBFileShare_readOnly' - A value that sets the write status of a file share. Set this value to
-- @true@ to set the write status to read-only, otherwise set to @false@.
--
-- Valid Values: @true@ | @false@
--
-- 'requesterPays', 'createSMBFileShare_requesterPays' - A value that sets who pays the cost of the request and the cost
-- associated with data download from the S3 bucket. If this value is set
-- to @true@, the requester pays the costs; otherwise, the S3 bucket owner
-- pays. However, the S3 bucket owner always pays the cost of storing data.
--
-- @RequesterPays@ is a configuration for the S3 bucket that backs the file
-- share, so make sure that the configuration on the file share is the same
-- as the S3 bucket configuration.
--
-- Valid Values: @true@ | @false@
--
-- 'sMBACLEnabled', 'createSMBFileShare_sMBACLEnabled' - Set this value to @true@ to enable access control list (ACL) on the SMB
-- file share. Set it to @false@ to map file and directory permissions to
-- the POSIX permissions.
--
-- For more information, see
-- <https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html Using Microsoft Windows ACLs to control access to an SMB file share>
-- in the /Storage Gateway User Guide/.
--
-- Valid Values: @true@ | @false@
--
-- 'tags', 'createSMBFileShare_tags' - A list of up to 50 tags that can be assigned to the NFS file share. Each
-- tag is a key-value pair.
--
-- Valid characters for key and value are letters, spaces, and numbers
-- representable in UTF-8 format, and the following special characters: + -
-- = . _ : \/ \@. The maximum length of a tag\'s key is 128 characters, and
-- the maximum length for a tag\'s value is 256.
--
-- 'vPCEndpointDNSName', 'createSMBFileShare_vPCEndpointDNSName' - Specifies the DNS name for the VPC endpoint that the SMB file share uses
-- to connect to Amazon S3.
--
-- This parameter is required for SMB file shares that connect to Amazon S3
-- through a VPC endpoint, a VPC access point, or an access point alias
-- that points to a VPC access point.
--
-- 'validUserList', 'createSMBFileShare_validUserList' - A list of users or groups in the Active Directory that are allowed to
-- access the file < > share. A group must be prefixed with the \@
-- character. Acceptable formats include: @DOMAIN\\User1@, @user1@,
-- @\@group1@, and @\@DOMAIN\\group1@. Can only be set if Authentication is
-- set to @ActiveDirectory@.
--
-- 'clientToken', 'createSMBFileShare_clientToken' - A unique string value that you supply that is used by S3 File Gateway to
-- ensure idempotent file share creation.
--
-- 'gatewayARN', 'createSMBFileShare_gatewayARN' - The ARN of the S3 File Gateway on which you want to create a file share.
--
-- 'role'', 'createSMBFileShare_role' - The ARN of the Identity and Access Management (IAM) role that an S3 File
-- Gateway assumes when it accesses the underlying storage.
--
-- 'locationARN', 'createSMBFileShare_locationARN' - A custom ARN for the backend storage used for storing data for file
-- shares. It includes a resource ARN with an optional prefix
-- concatenation. The prefix must end with a forward slash (\/).
--
-- You can specify LocationARN as a bucket ARN, access point ARN or access
-- point alias, as shown in the following examples.
--
-- Bucket ARN:
--
-- @arn:aws:s3:::my-bucket\/prefix\/@
--
-- Access point ARN:
--
-- @arn:aws:s3:region:account-id:accesspoint\/access-point-name\/prefix\/@
--
-- If you specify an access point, the bucket policy must be configured to
-- delegate access control to the access point. For information, see
-- <https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control Delegating access control to access points>
-- in the /Amazon S3 User Guide/.
--
-- Access point alias:
--
-- @test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias@
newCreateSMBFileShare ::
  -- | 'clientToken'
  Prelude.Text ->
  -- | 'gatewayARN'
  Prelude.Text ->
  -- | 'role''
  Prelude.Text ->
  -- | 'locationARN'
  Prelude.Text ->
  CreateSMBFileShare
newCreateSMBFileShare :: Text -> Text -> Text -> Text -> CreateSMBFileShare
newCreateSMBFileShare
  Text
pClientToken_
  Text
pGatewayARN_
  Text
pRole_
  Text
pLocationARN_ =
    CreateSMBFileShare'
      { $sel:accessBasedEnumeration:CreateSMBFileShare' :: Maybe Bool
accessBasedEnumeration =
          forall a. Maybe a
Prelude.Nothing,
        $sel:adminUserList:CreateSMBFileShare' :: Maybe [Text]
adminUserList = forall a. Maybe a
Prelude.Nothing,
        $sel:auditDestinationARN:CreateSMBFileShare' :: Maybe Text
auditDestinationARN = forall a. Maybe a
Prelude.Nothing,
        $sel:authentication:CreateSMBFileShare' :: Maybe Text
authentication = forall a. Maybe a
Prelude.Nothing,
        $sel:bucketRegion:CreateSMBFileShare' :: Maybe Text
bucketRegion = forall a. Maybe a
Prelude.Nothing,
        $sel:cacheAttributes:CreateSMBFileShare' :: Maybe CacheAttributes
cacheAttributes = forall a. Maybe a
Prelude.Nothing,
        $sel:caseSensitivity:CreateSMBFileShare' :: Maybe CaseSensitivity
caseSensitivity = forall a. Maybe a
Prelude.Nothing,
        $sel:defaultStorageClass:CreateSMBFileShare' :: Maybe Text
defaultStorageClass = forall a. Maybe a
Prelude.Nothing,
        $sel:fileShareName:CreateSMBFileShare' :: Maybe Text
fileShareName = forall a. Maybe a
Prelude.Nothing,
        $sel:guessMIMETypeEnabled:CreateSMBFileShare' :: Maybe Bool
guessMIMETypeEnabled = forall a. Maybe a
Prelude.Nothing,
        $sel:invalidUserList:CreateSMBFileShare' :: Maybe [Text]
invalidUserList = forall a. Maybe a
Prelude.Nothing,
        $sel:kmsEncrypted:CreateSMBFileShare' :: Maybe Bool
kmsEncrypted = forall a. Maybe a
Prelude.Nothing,
        $sel:kmsKey:CreateSMBFileShare' :: Maybe Text
kmsKey = forall a. Maybe a
Prelude.Nothing,
        $sel:notificationPolicy:CreateSMBFileShare' :: Maybe Text
notificationPolicy = forall a. Maybe a
Prelude.Nothing,
        $sel:objectACL:CreateSMBFileShare' :: Maybe ObjectACL
objectACL = forall a. Maybe a
Prelude.Nothing,
        $sel:oplocksEnabled:CreateSMBFileShare' :: Maybe Bool
oplocksEnabled = forall a. Maybe a
Prelude.Nothing,
        $sel:readOnly:CreateSMBFileShare' :: Maybe Bool
readOnly = forall a. Maybe a
Prelude.Nothing,
        $sel:requesterPays:CreateSMBFileShare' :: Maybe Bool
requesterPays = forall a. Maybe a
Prelude.Nothing,
        $sel:sMBACLEnabled:CreateSMBFileShare' :: Maybe Bool
sMBACLEnabled = forall a. Maybe a
Prelude.Nothing,
        $sel:tags:CreateSMBFileShare' :: Maybe [Tag]
tags = forall a. Maybe a
Prelude.Nothing,
        $sel:vPCEndpointDNSName:CreateSMBFileShare' :: Maybe Text
vPCEndpointDNSName = forall a. Maybe a
Prelude.Nothing,
        $sel:validUserList:CreateSMBFileShare' :: Maybe [Text]
validUserList = forall a. Maybe a
Prelude.Nothing,
        $sel:clientToken:CreateSMBFileShare' :: Text
clientToken = Text
pClientToken_,
        $sel:gatewayARN:CreateSMBFileShare' :: Text
gatewayARN = Text
pGatewayARN_,
        $sel:role':CreateSMBFileShare' :: Text
role' = Text
pRole_,
        $sel:locationARN:CreateSMBFileShare' :: Text
locationARN = Text
pLocationARN_
      }

-- | The files and folders on this share will only be visible to users with
-- read access.
createSMBFileShare_accessBasedEnumeration :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe Prelude.Bool)
createSMBFileShare_accessBasedEnumeration :: Lens' CreateSMBFileShare (Maybe Bool)
createSMBFileShare_accessBasedEnumeration = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe Bool
accessBasedEnumeration :: Maybe Bool
$sel:accessBasedEnumeration:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
accessBasedEnumeration} -> Maybe Bool
accessBasedEnumeration) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe Bool
a -> CreateSMBFileShare
s {$sel:accessBasedEnumeration:CreateSMBFileShare' :: Maybe Bool
accessBasedEnumeration = Maybe Bool
a} :: CreateSMBFileShare)

-- | A list of users or groups in the Active Directory that will be granted
-- administrator privileges on the file share. These users can do all file
-- operations as the super-user. Acceptable formats include:
-- @DOMAIN\\User1@, @user1@, @\@group1@, and @\@DOMAIN\\group1@.
--
-- Use this option very carefully, because any user in this list can do
-- anything they like on the file share, regardless of file permissions.
createSMBFileShare_adminUserList :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe [Prelude.Text])
createSMBFileShare_adminUserList :: Lens' CreateSMBFileShare (Maybe [Text])
createSMBFileShare_adminUserList = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe [Text]
adminUserList :: Maybe [Text]
$sel:adminUserList:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe [Text]
adminUserList} -> Maybe [Text]
adminUserList) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe [Text]
a -> CreateSMBFileShare
s {$sel:adminUserList:CreateSMBFileShare' :: Maybe [Text]
adminUserList = Maybe [Text]
a} :: CreateSMBFileShare) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The Amazon Resource Name (ARN) of the storage used for audit logs.
createSMBFileShare_auditDestinationARN :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe Prelude.Text)
createSMBFileShare_auditDestinationARN :: Lens' CreateSMBFileShare (Maybe Text)
createSMBFileShare_auditDestinationARN = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe Text
auditDestinationARN :: Maybe Text
$sel:auditDestinationARN:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
auditDestinationARN} -> Maybe Text
auditDestinationARN) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe Text
a -> CreateSMBFileShare
s {$sel:auditDestinationARN:CreateSMBFileShare' :: Maybe Text
auditDestinationARN = Maybe Text
a} :: CreateSMBFileShare)

-- | The authentication method that users use to access the file share. The
-- default is @ActiveDirectory@.
--
-- Valid Values: @ActiveDirectory@ | @GuestAccess@
createSMBFileShare_authentication :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe Prelude.Text)
createSMBFileShare_authentication :: Lens' CreateSMBFileShare (Maybe Text)
createSMBFileShare_authentication = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe Text
authentication :: Maybe Text
$sel:authentication:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
authentication} -> Maybe Text
authentication) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe Text
a -> CreateSMBFileShare
s {$sel:authentication:CreateSMBFileShare' :: Maybe Text
authentication = Maybe Text
a} :: CreateSMBFileShare)

-- | Specifies the Region of the S3 bucket where the SMB file share stores
-- files.
--
-- This parameter is required for SMB file shares that connect to Amazon S3
-- through a VPC endpoint, a VPC access point, or an access point alias
-- that points to a VPC access point.
createSMBFileShare_bucketRegion :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe Prelude.Text)
createSMBFileShare_bucketRegion :: Lens' CreateSMBFileShare (Maybe Text)
createSMBFileShare_bucketRegion = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe Text
bucketRegion :: Maybe Text
$sel:bucketRegion:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
bucketRegion} -> Maybe Text
bucketRegion) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe Text
a -> CreateSMBFileShare
s {$sel:bucketRegion:CreateSMBFileShare' :: Maybe Text
bucketRegion = Maybe Text
a} :: CreateSMBFileShare)

-- | Specifies refresh cache information for the file share.
createSMBFileShare_cacheAttributes :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe CacheAttributes)
createSMBFileShare_cacheAttributes :: Lens' CreateSMBFileShare (Maybe CacheAttributes)
createSMBFileShare_cacheAttributes = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe CacheAttributes
cacheAttributes :: Maybe CacheAttributes
$sel:cacheAttributes:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe CacheAttributes
cacheAttributes} -> Maybe CacheAttributes
cacheAttributes) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe CacheAttributes
a -> CreateSMBFileShare
s {$sel:cacheAttributes:CreateSMBFileShare' :: Maybe CacheAttributes
cacheAttributes = Maybe CacheAttributes
a} :: CreateSMBFileShare)

-- | The case of an object name in an Amazon S3 bucket. For
-- @ClientSpecified@, the client determines the case sensitivity. For
-- @CaseSensitive@, the gateway determines the case sensitivity. The
-- default value is @ClientSpecified@.
createSMBFileShare_caseSensitivity :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe CaseSensitivity)
createSMBFileShare_caseSensitivity :: Lens' CreateSMBFileShare (Maybe CaseSensitivity)
createSMBFileShare_caseSensitivity = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe CaseSensitivity
caseSensitivity :: Maybe CaseSensitivity
$sel:caseSensitivity:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe CaseSensitivity
caseSensitivity} -> Maybe CaseSensitivity
caseSensitivity) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe CaseSensitivity
a -> CreateSMBFileShare
s {$sel:caseSensitivity:CreateSMBFileShare' :: Maybe CaseSensitivity
caseSensitivity = Maybe CaseSensitivity
a} :: CreateSMBFileShare)

-- | The default storage class for objects put into an Amazon S3 bucket by
-- the S3 File Gateway. The default value is @S3_STANDARD@. Optional.
--
-- Valid Values: @S3_STANDARD@ | @S3_INTELLIGENT_TIERING@ |
-- @S3_STANDARD_IA@ | @S3_ONEZONE_IA@
createSMBFileShare_defaultStorageClass :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe Prelude.Text)
createSMBFileShare_defaultStorageClass :: Lens' CreateSMBFileShare (Maybe Text)
createSMBFileShare_defaultStorageClass = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe Text
defaultStorageClass :: Maybe Text
$sel:defaultStorageClass:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
defaultStorageClass} -> Maybe Text
defaultStorageClass) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe Text
a -> CreateSMBFileShare
s {$sel:defaultStorageClass:CreateSMBFileShare' :: Maybe Text
defaultStorageClass = Maybe Text
a} :: CreateSMBFileShare)

-- | The name of the file share. Optional.
--
-- @FileShareName@ must be set if an S3 prefix name is set in
-- @LocationARN@, or if an access point or access point alias is used.
createSMBFileShare_fileShareName :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe Prelude.Text)
createSMBFileShare_fileShareName :: Lens' CreateSMBFileShare (Maybe Text)
createSMBFileShare_fileShareName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe Text
fileShareName :: Maybe Text
$sel:fileShareName:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
fileShareName} -> Maybe Text
fileShareName) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe Text
a -> CreateSMBFileShare
s {$sel:fileShareName:CreateSMBFileShare' :: Maybe Text
fileShareName = Maybe Text
a} :: CreateSMBFileShare)

-- | A value that enables guessing of the MIME type for uploaded objects
-- based on file extensions. Set this value to @true@ to enable MIME type
-- guessing, otherwise set to @false@. The default value is @true@.
--
-- Valid Values: @true@ | @false@
createSMBFileShare_guessMIMETypeEnabled :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe Prelude.Bool)
createSMBFileShare_guessMIMETypeEnabled :: Lens' CreateSMBFileShare (Maybe Bool)
createSMBFileShare_guessMIMETypeEnabled = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe Bool
guessMIMETypeEnabled :: Maybe Bool
$sel:guessMIMETypeEnabled:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
guessMIMETypeEnabled} -> Maybe Bool
guessMIMETypeEnabled) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe Bool
a -> CreateSMBFileShare
s {$sel:guessMIMETypeEnabled:CreateSMBFileShare' :: Maybe Bool
guessMIMETypeEnabled = Maybe Bool
a} :: CreateSMBFileShare)

-- | A list of users or groups in the Active Directory that are not allowed
-- to access the file share. A group must be prefixed with the \@
-- character. Acceptable formats include: @DOMAIN\\User1@, @user1@,
-- @\@group1@, and @\@DOMAIN\\group1@. Can only be set if Authentication is
-- set to @ActiveDirectory@.
createSMBFileShare_invalidUserList :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe [Prelude.Text])
createSMBFileShare_invalidUserList :: Lens' CreateSMBFileShare (Maybe [Text])
createSMBFileShare_invalidUserList = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe [Text]
invalidUserList :: Maybe [Text]
$sel:invalidUserList:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe [Text]
invalidUserList} -> Maybe [Text]
invalidUserList) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe [Text]
a -> CreateSMBFileShare
s {$sel:invalidUserList:CreateSMBFileShare' :: Maybe [Text]
invalidUserList = Maybe [Text]
a} :: CreateSMBFileShare) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | Set to @true@ to use Amazon S3 server-side encryption with your own KMS
-- key, or @false@ to use a key managed by Amazon S3. Optional.
--
-- Valid Values: @true@ | @false@
createSMBFileShare_kmsEncrypted :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe Prelude.Bool)
createSMBFileShare_kmsEncrypted :: Lens' CreateSMBFileShare (Maybe Bool)
createSMBFileShare_kmsEncrypted = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe Bool
kmsEncrypted :: Maybe Bool
$sel:kmsEncrypted:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
kmsEncrypted} -> Maybe Bool
kmsEncrypted) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe Bool
a -> CreateSMBFileShare
s {$sel:kmsEncrypted:CreateSMBFileShare' :: Maybe Bool
kmsEncrypted = Maybe Bool
a} :: CreateSMBFileShare)

-- | The Amazon Resource Name (ARN) of a symmetric customer master key (CMK)
-- used for Amazon S3 server-side encryption. Storage Gateway does not
-- support asymmetric CMKs. This value can only be set when @KMSEncrypted@
-- is @true@. Optional.
createSMBFileShare_kmsKey :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe Prelude.Text)
createSMBFileShare_kmsKey :: Lens' CreateSMBFileShare (Maybe Text)
createSMBFileShare_kmsKey = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe Text
kmsKey :: Maybe Text
$sel:kmsKey:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
kmsKey} -> Maybe Text
kmsKey) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe Text
a -> CreateSMBFileShare
s {$sel:kmsKey:CreateSMBFileShare' :: Maybe Text
kmsKey = Maybe Text
a} :: CreateSMBFileShare)

-- | The notification policy of the file share. @SettlingTimeInSeconds@
-- controls the number of seconds to wait after the last point in time a
-- client wrote to a file before generating an @ObjectUploaded@
-- notification. Because clients can make many small writes to files, it\'s
-- best to set this parameter for as long as possible to avoid generating
-- multiple notifications for the same file in a small time period.
--
-- @SettlingTimeInSeconds@ has no effect on the timing of the object
-- uploading to Amazon S3, only the timing of the notification.
--
-- The following example sets @NotificationPolicy@ on with
-- @SettlingTimeInSeconds@ set to 60.
--
-- @{\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}@
--
-- The following example sets @NotificationPolicy@ off.
--
-- @{}@
createSMBFileShare_notificationPolicy :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe Prelude.Text)
createSMBFileShare_notificationPolicy :: Lens' CreateSMBFileShare (Maybe Text)
createSMBFileShare_notificationPolicy = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe Text
notificationPolicy :: Maybe Text
$sel:notificationPolicy:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
notificationPolicy} -> Maybe Text
notificationPolicy) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe Text
a -> CreateSMBFileShare
s {$sel:notificationPolicy:CreateSMBFileShare' :: Maybe Text
notificationPolicy = Maybe Text
a} :: CreateSMBFileShare)

-- | A value that sets the access control list (ACL) permission for objects
-- in the S3 bucket that a S3 File Gateway puts objects into. The default
-- value is @private@.
createSMBFileShare_objectACL :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe ObjectACL)
createSMBFileShare_objectACL :: Lens' CreateSMBFileShare (Maybe ObjectACL)
createSMBFileShare_objectACL = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe ObjectACL
objectACL :: Maybe ObjectACL
$sel:objectACL:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe ObjectACL
objectACL} -> Maybe ObjectACL
objectACL) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe ObjectACL
a -> CreateSMBFileShare
s {$sel:objectACL:CreateSMBFileShare' :: Maybe ObjectACL
objectACL = Maybe ObjectACL
a} :: CreateSMBFileShare)

-- | Specifies whether opportunistic locking is enabled for the SMB file
-- share.
--
-- Enabling opportunistic locking on case-sensitive shares is not
-- recommended for workloads that involve access to files with the same
-- name in different case.
--
-- Valid Values: @true@ | @false@
createSMBFileShare_oplocksEnabled :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe Prelude.Bool)
createSMBFileShare_oplocksEnabled :: Lens' CreateSMBFileShare (Maybe Bool)
createSMBFileShare_oplocksEnabled = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe Bool
oplocksEnabled :: Maybe Bool
$sel:oplocksEnabled:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
oplocksEnabled} -> Maybe Bool
oplocksEnabled) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe Bool
a -> CreateSMBFileShare
s {$sel:oplocksEnabled:CreateSMBFileShare' :: Maybe Bool
oplocksEnabled = Maybe Bool
a} :: CreateSMBFileShare)

-- | A value that sets the write status of a file share. Set this value to
-- @true@ to set the write status to read-only, otherwise set to @false@.
--
-- Valid Values: @true@ | @false@
createSMBFileShare_readOnly :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe Prelude.Bool)
createSMBFileShare_readOnly :: Lens' CreateSMBFileShare (Maybe Bool)
createSMBFileShare_readOnly = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe Bool
readOnly :: Maybe Bool
$sel:readOnly:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
readOnly} -> Maybe Bool
readOnly) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe Bool
a -> CreateSMBFileShare
s {$sel:readOnly:CreateSMBFileShare' :: Maybe Bool
readOnly = Maybe Bool
a} :: CreateSMBFileShare)

-- | A value that sets who pays the cost of the request and the cost
-- associated with data download from the S3 bucket. If this value is set
-- to @true@, the requester pays the costs; otherwise, the S3 bucket owner
-- pays. However, the S3 bucket owner always pays the cost of storing data.
--
-- @RequesterPays@ is a configuration for the S3 bucket that backs the file
-- share, so make sure that the configuration on the file share is the same
-- as the S3 bucket configuration.
--
-- Valid Values: @true@ | @false@
createSMBFileShare_requesterPays :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe Prelude.Bool)
createSMBFileShare_requesterPays :: Lens' CreateSMBFileShare (Maybe Bool)
createSMBFileShare_requesterPays = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe Bool
requesterPays :: Maybe Bool
$sel:requesterPays:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
requesterPays} -> Maybe Bool
requesterPays) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe Bool
a -> CreateSMBFileShare
s {$sel:requesterPays:CreateSMBFileShare' :: Maybe Bool
requesterPays = Maybe Bool
a} :: CreateSMBFileShare)

-- | Set this value to @true@ to enable access control list (ACL) on the SMB
-- file share. Set it to @false@ to map file and directory permissions to
-- the POSIX permissions.
--
-- For more information, see
-- <https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html Using Microsoft Windows ACLs to control access to an SMB file share>
-- in the /Storage Gateway User Guide/.
--
-- Valid Values: @true@ | @false@
createSMBFileShare_sMBACLEnabled :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe Prelude.Bool)
createSMBFileShare_sMBACLEnabled :: Lens' CreateSMBFileShare (Maybe Bool)
createSMBFileShare_sMBACLEnabled = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe Bool
sMBACLEnabled :: Maybe Bool
$sel:sMBACLEnabled:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
sMBACLEnabled} -> Maybe Bool
sMBACLEnabled) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe Bool
a -> CreateSMBFileShare
s {$sel:sMBACLEnabled:CreateSMBFileShare' :: Maybe Bool
sMBACLEnabled = Maybe Bool
a} :: CreateSMBFileShare)

-- | A list of up to 50 tags that can be assigned to the NFS file share. Each
-- tag is a key-value pair.
--
-- Valid characters for key and value are letters, spaces, and numbers
-- representable in UTF-8 format, and the following special characters: + -
-- = . _ : \/ \@. The maximum length of a tag\'s key is 128 characters, and
-- the maximum length for a tag\'s value is 256.
createSMBFileShare_tags :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe [Tag])
createSMBFileShare_tags :: Lens' CreateSMBFileShare (Maybe [Tag])
createSMBFileShare_tags = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe [Tag]
tags :: Maybe [Tag]
$sel:tags:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe [Tag]
tags} -> Maybe [Tag]
tags) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe [Tag]
a -> CreateSMBFileShare
s {$sel:tags:CreateSMBFileShare' :: Maybe [Tag]
tags = Maybe [Tag]
a} :: CreateSMBFileShare) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | Specifies the DNS name for the VPC endpoint that the SMB file share uses
-- to connect to Amazon S3.
--
-- This parameter is required for SMB file shares that connect to Amazon S3
-- through a VPC endpoint, a VPC access point, or an access point alias
-- that points to a VPC access point.
createSMBFileShare_vPCEndpointDNSName :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe Prelude.Text)
createSMBFileShare_vPCEndpointDNSName :: Lens' CreateSMBFileShare (Maybe Text)
createSMBFileShare_vPCEndpointDNSName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe Text
vPCEndpointDNSName :: Maybe Text
$sel:vPCEndpointDNSName:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
vPCEndpointDNSName} -> Maybe Text
vPCEndpointDNSName) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe Text
a -> CreateSMBFileShare
s {$sel:vPCEndpointDNSName:CreateSMBFileShare' :: Maybe Text
vPCEndpointDNSName = Maybe Text
a} :: CreateSMBFileShare)

-- | A list of users or groups in the Active Directory that are allowed to
-- access the file < > share. A group must be prefixed with the \@
-- character. Acceptable formats include: @DOMAIN\\User1@, @user1@,
-- @\@group1@, and @\@DOMAIN\\group1@. Can only be set if Authentication is
-- set to @ActiveDirectory@.
createSMBFileShare_validUserList :: Lens.Lens' CreateSMBFileShare (Prelude.Maybe [Prelude.Text])
createSMBFileShare_validUserList :: Lens' CreateSMBFileShare (Maybe [Text])
createSMBFileShare_validUserList = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Maybe [Text]
validUserList :: Maybe [Text]
$sel:validUserList:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe [Text]
validUserList} -> Maybe [Text]
validUserList) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Maybe [Text]
a -> CreateSMBFileShare
s {$sel:validUserList:CreateSMBFileShare' :: Maybe [Text]
validUserList = Maybe [Text]
a} :: CreateSMBFileShare) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | A unique string value that you supply that is used by S3 File Gateway to
-- ensure idempotent file share creation.
createSMBFileShare_clientToken :: Lens.Lens' CreateSMBFileShare Prelude.Text
createSMBFileShare_clientToken :: Lens' CreateSMBFileShare Text
createSMBFileShare_clientToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Text
clientToken :: Text
$sel:clientToken:CreateSMBFileShare' :: CreateSMBFileShare -> Text
clientToken} -> Text
clientToken) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Text
a -> CreateSMBFileShare
s {$sel:clientToken:CreateSMBFileShare' :: Text
clientToken = Text
a} :: CreateSMBFileShare)

-- | The ARN of the S3 File Gateway on which you want to create a file share.
createSMBFileShare_gatewayARN :: Lens.Lens' CreateSMBFileShare Prelude.Text
createSMBFileShare_gatewayARN :: Lens' CreateSMBFileShare Text
createSMBFileShare_gatewayARN = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Text
gatewayARN :: Text
$sel:gatewayARN:CreateSMBFileShare' :: CreateSMBFileShare -> Text
gatewayARN} -> Text
gatewayARN) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Text
a -> CreateSMBFileShare
s {$sel:gatewayARN:CreateSMBFileShare' :: Text
gatewayARN = Text
a} :: CreateSMBFileShare)

-- | The ARN of the Identity and Access Management (IAM) role that an S3 File
-- Gateway assumes when it accesses the underlying storage.
createSMBFileShare_role :: Lens.Lens' CreateSMBFileShare Prelude.Text
createSMBFileShare_role :: Lens' CreateSMBFileShare Text
createSMBFileShare_role = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Text
role' :: Text
$sel:role':CreateSMBFileShare' :: CreateSMBFileShare -> Text
role'} -> Text
role') (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Text
a -> CreateSMBFileShare
s {$sel:role':CreateSMBFileShare' :: Text
role' = Text
a} :: CreateSMBFileShare)

-- | A custom ARN for the backend storage used for storing data for file
-- shares. It includes a resource ARN with an optional prefix
-- concatenation. The prefix must end with a forward slash (\/).
--
-- You can specify LocationARN as a bucket ARN, access point ARN or access
-- point alias, as shown in the following examples.
--
-- Bucket ARN:
--
-- @arn:aws:s3:::my-bucket\/prefix\/@
--
-- Access point ARN:
--
-- @arn:aws:s3:region:account-id:accesspoint\/access-point-name\/prefix\/@
--
-- If you specify an access point, the bucket policy must be configured to
-- delegate access control to the access point. For information, see
-- <https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control Delegating access control to access points>
-- in the /Amazon S3 User Guide/.
--
-- Access point alias:
--
-- @test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias@
createSMBFileShare_locationARN :: Lens.Lens' CreateSMBFileShare Prelude.Text
createSMBFileShare_locationARN :: Lens' CreateSMBFileShare Text
createSMBFileShare_locationARN = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShare' {Text
locationARN :: Text
$sel:locationARN:CreateSMBFileShare' :: CreateSMBFileShare -> Text
locationARN} -> Text
locationARN) (\s :: CreateSMBFileShare
s@CreateSMBFileShare' {} Text
a -> CreateSMBFileShare
s {$sel:locationARN:CreateSMBFileShare' :: Text
locationARN = Text
a} :: CreateSMBFileShare)

instance Core.AWSRequest CreateSMBFileShare where
  type
    AWSResponse CreateSMBFileShare =
      CreateSMBFileShareResponse
  request :: (Service -> Service)
-> CreateSMBFileShare -> Request CreateSMBFileShare
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy CreateSMBFileShare
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse CreateSMBFileShare)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe Text -> Int -> CreateSMBFileShareResponse
CreateSMBFileShareResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"FileShareARN")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable CreateSMBFileShare where
  hashWithSalt :: Int -> CreateSMBFileShare -> Int
hashWithSalt Int
_salt CreateSMBFileShare' {Maybe Bool
Maybe [Text]
Maybe [Tag]
Maybe Text
Maybe CacheAttributes
Maybe CaseSensitivity
Maybe ObjectACL
Text
locationARN :: Text
role' :: Text
gatewayARN :: Text
clientToken :: Text
validUserList :: Maybe [Text]
vPCEndpointDNSName :: Maybe Text
tags :: Maybe [Tag]
sMBACLEnabled :: Maybe Bool
requesterPays :: Maybe Bool
readOnly :: Maybe Bool
oplocksEnabled :: Maybe Bool
objectACL :: Maybe ObjectACL
notificationPolicy :: Maybe Text
kmsKey :: Maybe Text
kmsEncrypted :: Maybe Bool
invalidUserList :: Maybe [Text]
guessMIMETypeEnabled :: Maybe Bool
fileShareName :: Maybe Text
defaultStorageClass :: Maybe Text
caseSensitivity :: Maybe CaseSensitivity
cacheAttributes :: Maybe CacheAttributes
bucketRegion :: Maybe Text
authentication :: Maybe Text
auditDestinationARN :: Maybe Text
adminUserList :: Maybe [Text]
accessBasedEnumeration :: Maybe Bool
$sel:locationARN:CreateSMBFileShare' :: CreateSMBFileShare -> Text
$sel:role':CreateSMBFileShare' :: CreateSMBFileShare -> Text
$sel:gatewayARN:CreateSMBFileShare' :: CreateSMBFileShare -> Text
$sel:clientToken:CreateSMBFileShare' :: CreateSMBFileShare -> Text
$sel:validUserList:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe [Text]
$sel:vPCEndpointDNSName:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:tags:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe [Tag]
$sel:sMBACLEnabled:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:requesterPays:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:readOnly:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:oplocksEnabled:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:objectACL:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe ObjectACL
$sel:notificationPolicy:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:kmsKey:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:kmsEncrypted:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:invalidUserList:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe [Text]
$sel:guessMIMETypeEnabled:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:fileShareName:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:defaultStorageClass:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:caseSensitivity:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe CaseSensitivity
$sel:cacheAttributes:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe CacheAttributes
$sel:bucketRegion:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:authentication:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:auditDestinationARN:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:adminUserList:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe [Text]
$sel:accessBasedEnumeration:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
accessBasedEnumeration
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
adminUserList
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
auditDestinationARN
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
authentication
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
bucketRegion
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe CacheAttributes
cacheAttributes
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe CaseSensitivity
caseSensitivity
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
defaultStorageClass
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
fileShareName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
guessMIMETypeEnabled
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
invalidUserList
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
kmsEncrypted
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
kmsKey
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
notificationPolicy
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ObjectACL
objectACL
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
oplocksEnabled
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
readOnly
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
requesterPays
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
sMBACLEnabled
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Tag]
tags
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
vPCEndpointDNSName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
validUserList
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
clientToken
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
gatewayARN
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
role'
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
locationARN

instance Prelude.NFData CreateSMBFileShare where
  rnf :: CreateSMBFileShare -> ()
rnf CreateSMBFileShare' {Maybe Bool
Maybe [Text]
Maybe [Tag]
Maybe Text
Maybe CacheAttributes
Maybe CaseSensitivity
Maybe ObjectACL
Text
locationARN :: Text
role' :: Text
gatewayARN :: Text
clientToken :: Text
validUserList :: Maybe [Text]
vPCEndpointDNSName :: Maybe Text
tags :: Maybe [Tag]
sMBACLEnabled :: Maybe Bool
requesterPays :: Maybe Bool
readOnly :: Maybe Bool
oplocksEnabled :: Maybe Bool
objectACL :: Maybe ObjectACL
notificationPolicy :: Maybe Text
kmsKey :: Maybe Text
kmsEncrypted :: Maybe Bool
invalidUserList :: Maybe [Text]
guessMIMETypeEnabled :: Maybe Bool
fileShareName :: Maybe Text
defaultStorageClass :: Maybe Text
caseSensitivity :: Maybe CaseSensitivity
cacheAttributes :: Maybe CacheAttributes
bucketRegion :: Maybe Text
authentication :: Maybe Text
auditDestinationARN :: Maybe Text
adminUserList :: Maybe [Text]
accessBasedEnumeration :: Maybe Bool
$sel:locationARN:CreateSMBFileShare' :: CreateSMBFileShare -> Text
$sel:role':CreateSMBFileShare' :: CreateSMBFileShare -> Text
$sel:gatewayARN:CreateSMBFileShare' :: CreateSMBFileShare -> Text
$sel:clientToken:CreateSMBFileShare' :: CreateSMBFileShare -> Text
$sel:validUserList:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe [Text]
$sel:vPCEndpointDNSName:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:tags:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe [Tag]
$sel:sMBACLEnabled:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:requesterPays:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:readOnly:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:oplocksEnabled:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:objectACL:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe ObjectACL
$sel:notificationPolicy:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:kmsKey:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:kmsEncrypted:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:invalidUserList:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe [Text]
$sel:guessMIMETypeEnabled:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:fileShareName:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:defaultStorageClass:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:caseSensitivity:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe CaseSensitivity
$sel:cacheAttributes:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe CacheAttributes
$sel:bucketRegion:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:authentication:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:auditDestinationARN:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:adminUserList:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe [Text]
$sel:accessBasedEnumeration:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
accessBasedEnumeration
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
adminUserList
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
auditDestinationARN
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
authentication
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
bucketRegion
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe CacheAttributes
cacheAttributes
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe CaseSensitivity
caseSensitivity
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
defaultStorageClass
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
fileShareName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
guessMIMETypeEnabled
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
invalidUserList
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
kmsEncrypted
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
kmsKey
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
notificationPolicy
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ObjectACL
objectACL
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
oplocksEnabled
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
readOnly
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
requesterPays
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
sMBACLEnabled
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Tag]
tags
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf
        Maybe Text
vPCEndpointDNSName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
validUserList
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
clientToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
gatewayARN
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
role'
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf
        Text
locationARN

instance Data.ToHeaders CreateSMBFileShare where
  toHeaders :: CreateSMBFileShare -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"StorageGateway_20130630.CreateSMBFileShare" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON CreateSMBFileShare where
  toJSON :: CreateSMBFileShare -> Value
toJSON CreateSMBFileShare' {Maybe Bool
Maybe [Text]
Maybe [Tag]
Maybe Text
Maybe CacheAttributes
Maybe CaseSensitivity
Maybe ObjectACL
Text
locationARN :: Text
role' :: Text
gatewayARN :: Text
clientToken :: Text
validUserList :: Maybe [Text]
vPCEndpointDNSName :: Maybe Text
tags :: Maybe [Tag]
sMBACLEnabled :: Maybe Bool
requesterPays :: Maybe Bool
readOnly :: Maybe Bool
oplocksEnabled :: Maybe Bool
objectACL :: Maybe ObjectACL
notificationPolicy :: Maybe Text
kmsKey :: Maybe Text
kmsEncrypted :: Maybe Bool
invalidUserList :: Maybe [Text]
guessMIMETypeEnabled :: Maybe Bool
fileShareName :: Maybe Text
defaultStorageClass :: Maybe Text
caseSensitivity :: Maybe CaseSensitivity
cacheAttributes :: Maybe CacheAttributes
bucketRegion :: Maybe Text
authentication :: Maybe Text
auditDestinationARN :: Maybe Text
adminUserList :: Maybe [Text]
accessBasedEnumeration :: Maybe Bool
$sel:locationARN:CreateSMBFileShare' :: CreateSMBFileShare -> Text
$sel:role':CreateSMBFileShare' :: CreateSMBFileShare -> Text
$sel:gatewayARN:CreateSMBFileShare' :: CreateSMBFileShare -> Text
$sel:clientToken:CreateSMBFileShare' :: CreateSMBFileShare -> Text
$sel:validUserList:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe [Text]
$sel:vPCEndpointDNSName:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:tags:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe [Tag]
$sel:sMBACLEnabled:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:requesterPays:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:readOnly:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:oplocksEnabled:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:objectACL:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe ObjectACL
$sel:notificationPolicy:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:kmsKey:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:kmsEncrypted:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:invalidUserList:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe [Text]
$sel:guessMIMETypeEnabled:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
$sel:fileShareName:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:defaultStorageClass:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:caseSensitivity:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe CaseSensitivity
$sel:cacheAttributes:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe CacheAttributes
$sel:bucketRegion:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:authentication:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:auditDestinationARN:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Text
$sel:adminUserList:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe [Text]
$sel:accessBasedEnumeration:CreateSMBFileShare' :: CreateSMBFileShare -> Maybe Bool
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"AccessBasedEnumeration" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
accessBasedEnumeration,
            (Key
"AdminUserList" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Text]
adminUserList,
            (Key
"AuditDestinationARN" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
auditDestinationARN,
            (Key
"Authentication" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
authentication,
            (Key
"BucketRegion" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
bucketRegion,
            (Key
"CacheAttributes" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe CacheAttributes
cacheAttributes,
            (Key
"CaseSensitivity" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe CaseSensitivity
caseSensitivity,
            (Key
"DefaultStorageClass" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
defaultStorageClass,
            (Key
"FileShareName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
fileShareName,
            (Key
"GuessMIMETypeEnabled" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
guessMIMETypeEnabled,
            (Key
"InvalidUserList" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Text]
invalidUserList,
            (Key
"KMSEncrypted" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
kmsEncrypted,
            (Key
"KMSKey" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
kmsKey,
            (Key
"NotificationPolicy" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
notificationPolicy,
            (Key
"ObjectACL" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe ObjectACL
objectACL,
            (Key
"OplocksEnabled" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
oplocksEnabled,
            (Key
"ReadOnly" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
readOnly,
            (Key
"RequesterPays" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
requesterPays,
            (Key
"SMBACLEnabled" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
sMBACLEnabled,
            (Key
"Tags" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Tag]
tags,
            (Key
"VPCEndpointDNSName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
vPCEndpointDNSName,
            (Key
"ValidUserList" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Text]
validUserList,
            forall a. a -> Maybe a
Prelude.Just (Key
"ClientToken" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
clientToken),
            forall a. a -> Maybe a
Prelude.Just (Key
"GatewayARN" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
gatewayARN),
            forall a. a -> Maybe a
Prelude.Just (Key
"Role" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
role'),
            forall a. a -> Maybe a
Prelude.Just (Key
"LocationARN" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
locationARN)
          ]
      )

instance Data.ToPath CreateSMBFileShare where
  toPath :: CreateSMBFileShare -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery CreateSMBFileShare where
  toQuery :: CreateSMBFileShare -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | CreateSMBFileShareOutput
--
-- /See:/ 'newCreateSMBFileShareResponse' smart constructor.
data CreateSMBFileShareResponse = CreateSMBFileShareResponse'
  { -- | The Amazon Resource Name (ARN) of the newly created file share.
    CreateSMBFileShareResponse -> Maybe Text
fileShareARN :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    CreateSMBFileShareResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (CreateSMBFileShareResponse -> CreateSMBFileShareResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CreateSMBFileShareResponse -> CreateSMBFileShareResponse -> Bool
$c/= :: CreateSMBFileShareResponse -> CreateSMBFileShareResponse -> Bool
== :: CreateSMBFileShareResponse -> CreateSMBFileShareResponse -> Bool
$c== :: CreateSMBFileShareResponse -> CreateSMBFileShareResponse -> Bool
Prelude.Eq, ReadPrec [CreateSMBFileShareResponse]
ReadPrec CreateSMBFileShareResponse
Int -> ReadS CreateSMBFileShareResponse
ReadS [CreateSMBFileShareResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CreateSMBFileShareResponse]
$creadListPrec :: ReadPrec [CreateSMBFileShareResponse]
readPrec :: ReadPrec CreateSMBFileShareResponse
$creadPrec :: ReadPrec CreateSMBFileShareResponse
readList :: ReadS [CreateSMBFileShareResponse]
$creadList :: ReadS [CreateSMBFileShareResponse]
readsPrec :: Int -> ReadS CreateSMBFileShareResponse
$creadsPrec :: Int -> ReadS CreateSMBFileShareResponse
Prelude.Read, Int -> CreateSMBFileShareResponse -> ShowS
[CreateSMBFileShareResponse] -> ShowS
CreateSMBFileShareResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CreateSMBFileShareResponse] -> ShowS
$cshowList :: [CreateSMBFileShareResponse] -> ShowS
show :: CreateSMBFileShareResponse -> String
$cshow :: CreateSMBFileShareResponse -> String
showsPrec :: Int -> CreateSMBFileShareResponse -> ShowS
$cshowsPrec :: Int -> CreateSMBFileShareResponse -> ShowS
Prelude.Show, forall x.
Rep CreateSMBFileShareResponse x -> CreateSMBFileShareResponse
forall x.
CreateSMBFileShareResponse -> Rep CreateSMBFileShareResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep CreateSMBFileShareResponse x -> CreateSMBFileShareResponse
$cfrom :: forall x.
CreateSMBFileShareResponse -> Rep CreateSMBFileShareResponse x
Prelude.Generic)

-- |
-- Create a value of 'CreateSMBFileShareResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'fileShareARN', 'createSMBFileShareResponse_fileShareARN' - The Amazon Resource Name (ARN) of the newly created file share.
--
-- 'httpStatus', 'createSMBFileShareResponse_httpStatus' - The response's http status code.
newCreateSMBFileShareResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  CreateSMBFileShareResponse
newCreateSMBFileShareResponse :: Int -> CreateSMBFileShareResponse
newCreateSMBFileShareResponse Int
pHttpStatus_ =
  CreateSMBFileShareResponse'
    { $sel:fileShareARN:CreateSMBFileShareResponse' :: Maybe Text
fileShareARN =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:CreateSMBFileShareResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The Amazon Resource Name (ARN) of the newly created file share.
createSMBFileShareResponse_fileShareARN :: Lens.Lens' CreateSMBFileShareResponse (Prelude.Maybe Prelude.Text)
createSMBFileShareResponse_fileShareARN :: Lens' CreateSMBFileShareResponse (Maybe Text)
createSMBFileShareResponse_fileShareARN = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShareResponse' {Maybe Text
fileShareARN :: Maybe Text
$sel:fileShareARN:CreateSMBFileShareResponse' :: CreateSMBFileShareResponse -> Maybe Text
fileShareARN} -> Maybe Text
fileShareARN) (\s :: CreateSMBFileShareResponse
s@CreateSMBFileShareResponse' {} Maybe Text
a -> CreateSMBFileShareResponse
s {$sel:fileShareARN:CreateSMBFileShareResponse' :: Maybe Text
fileShareARN = Maybe Text
a} :: CreateSMBFileShareResponse)

-- | The response's http status code.
createSMBFileShareResponse_httpStatus :: Lens.Lens' CreateSMBFileShareResponse Prelude.Int
createSMBFileShareResponse_httpStatus :: Lens' CreateSMBFileShareResponse Int
createSMBFileShareResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateSMBFileShareResponse' {Int
httpStatus :: Int
$sel:httpStatus:CreateSMBFileShareResponse' :: CreateSMBFileShareResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: CreateSMBFileShareResponse
s@CreateSMBFileShareResponse' {} Int
a -> CreateSMBFileShareResponse
s {$sel:httpStatus:CreateSMBFileShareResponse' :: Int
httpStatus = Int
a} :: CreateSMBFileShareResponse)

instance Prelude.NFData CreateSMBFileShareResponse where
  rnf :: CreateSMBFileShareResponse -> ()
rnf CreateSMBFileShareResponse' {Int
Maybe Text
httpStatus :: Int
fileShareARN :: Maybe Text
$sel:httpStatus:CreateSMBFileShareResponse' :: CreateSMBFileShareResponse -> Int
$sel:fileShareARN:CreateSMBFileShareResponse' :: CreateSMBFileShareResponse -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
fileShareARN
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus