AWS Storage Gateway Service
API Reference (API Version 2013-06-30)

SMBFileShareInfo

The Windows file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported for file gateways.

Contents

Authentication

The authentication method of the file share.

Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 15.

Required: No

DefaultStorageClass

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

Type: String

Length Constraints: Minimum length of 5. Maximum length of 20.

Required: No

FileShareARN

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

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Required: No

FileShareId

The ID of the file share.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 30.

Required: No

FileShareStatus

The status of the file share. Possible values are CREATING, UPDATING, AVAILABLE and DELETING.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 50.

Required: No

GatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Required: No

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, and otherwise to false. The default value is true.

Type: Boolean

Required: No

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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

KMSEncrypted

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.

Type: Boolean

Required: No

KMSKey

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

LocationARN

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

Type: String

Length Constraints: Minimum length of 16. Maximum length of 310.

Required: No

ObjectACL

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

Type: String

Valid Values: private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control | aws-exec-read

Required: No

Path

The file share path used by the SMB client to identify the mount point.

Type: String

Required: No

ReadOnly

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

Type: Boolean

Required: No

RequesterPays

A value that 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.

Type: Boolean

Required: No

Role

The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: