aws_storagegateway_smb_fileshare

access_based_enumeration

Type: BOOLEAN
Provider name: AccessBasedEnumeration
Description: Indicates whether AccessBasedEnumeration is enabled.

account_id

Type: STRING

admin_user_list

Type: UNORDERED_LIST_STRING
Provider name: AdminUserList
Description: A list of users or groups in the Active Directory that have administrator rights to 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.

audit_destination_arn

Type: STRING
Provider name: AuditDestinationARN
Description: The Amazon Resource Name (ARN) of the storage used for audit logs.

authentication

Type: STRING
Provider name: Authentication

bucket_region

Type: STRING
Provider name: BucketRegion
Description: 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.

cache_attributes

Type: STRUCT
Provider name: CacheAttributes
Description: Refresh cache information for the file share.

• cache_stale_timeout_in_seconds
  Type: INT32
  Provider name: CacheStaleTimeoutInSeconds
  Description: Refreshes a file share’s cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory’s contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds. Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
  

case_sensitivity

Type: STRING
Provider name: CaseSensitivity
Description: 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.

default_storage_class

Type: STRING
Provider name: DefaultStorageClass
Description: 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

encryption_type

Type: STRING
Provider name: EncryptionType
Description: A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3. We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters. If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.

file_share_arn

Type: STRING
Provider name: FileShareARN

file_share_id

Type: STRING
Provider name: FileShareId

file_share_name

Type: STRING
Provider name: FileShareName
Description: 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.

file_share_status

Type: STRING
Provider name: FileShareStatus

gateway_arn

Type: STRING
Provider name: GatewayARN

guess_mime_type_enabled

Type: BOOLEAN
Provider name: GuessMIMETypeEnabled
Description: 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

invalid_user_list

Type: UNORDERED_LIST_STRING
Provider name: InvalidUserList
Description: 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.

kms_encrypted

Type: BOOLEAN
Provider name: KMSEncrypted
Description: Optional. Set to true to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or false to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the EncryptionType parameter instead. We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters. If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true. Valid Values: true | false

kms_key

Type: STRING
Provider name: KMSKey

location_arn

Type: STRING
Provider name: LocationARN

notification_policy

Type: STRING
Provider name: NotificationPolicy
Description: 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. This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications. The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60. {"Upload": {"SettlingTimeInSeconds": 60}} The following example sets NotificationPolicy off. {}

object_acl

Type: STRING
Provider name: ObjectACL

oplocks_enabled

Type: BOOLEAN
Provider name: OplocksEnabled
Description: 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

path

Type: STRING
Provider name: Path
Description: The file share path used by the SMB client to identify the mount point.

read_only

Type: BOOLEAN
Provider name: ReadOnly
Description: 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

requester_pays

Type: BOOLEAN
Provider name: RequesterPays
Description: 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

role

Type: STRING
Provider name: Role

smbacl_enabled

Type: BOOLEAN
Provider name: SMBACLEnabled
Description: If this value is set to true, it indicates that access control list (ACL) is enabled on the SMB file share. If it is set to false, it indicates that file and directory permissions are mapped to the POSIX permission. For more information, see Using Windows ACLs to limit SMB file share access in the Amazon S3 File Gateway User Guide.

tags

Type: UNORDERED_LIST_STRING

valid_user_list

Type: UNORDERED_LIST_STRING
Provider name: ValidUserList
Description: 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.

vpc_endpoint_dns_name

Type: STRING
Provider name: VPCEndpointDNSName
Description: 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.