/AWS1/CL_STGSMBFILESHAREINFO

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

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_filesharearn TYPE /AWS1/STGFILESHAREARN /AWS1/STGFILESHAREARN

FileShareARN

iv_fileshareid TYPE /AWS1/STGFILESHAREID /AWS1/STGFILESHAREID

FileShareId

iv_filesharestatus TYPE /AWS1/STGFILESHARESTATUS /AWS1/STGFILESHARESTATUS

FileShareStatus

iv_gatewayarn TYPE /AWS1/STGGATEWAYARN /AWS1/STGGATEWAYARN

GatewayARN

iv_encryptiontype TYPE /AWS1/STGENCRYPTIONTYPE /AWS1/STGENCRYPTIONTYPE

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.

iv_kmsencrypted TYPE /AWS1/STGBOOLEAN2 /AWS1/STGBOOLEAN2

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

iv_kmskey TYPE /AWS1/STGKMSKEY /AWS1/STGKMSKEY

KMSKey

iv_path TYPE /AWS1/STGPATH /AWS1/STGPATH

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

iv_role TYPE /AWS1/STGROLE /AWS1/STGROLE

Role

iv_locationarn TYPE /AWS1/STGLOCATIONARN /AWS1/STGLOCATIONARN

LocationARN

iv_defaultstorageclass TYPE /AWS1/STGSTORAGECLASS /AWS1/STGSTORAGECLASS

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

iv_objectacl TYPE /AWS1/STGOBJECTACL /AWS1/STGOBJECTACL

ObjectACL

iv_readonly TYPE /AWS1/STGBOOLEAN /AWS1/STGBOOLEAN

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

iv_guessmimetypeenabled TYPE /AWS1/STGBOOLEAN /AWS1/STGBOOLEAN

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

iv_requesterpays TYPE /AWS1/STGBOOLEAN /AWS1/STGBOOLEAN

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

iv_smbaclenabled TYPE /AWS1/STGBOOLEAN /AWS1/STGBOOLEAN

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.

iv_accessbasedenumeration TYPE /AWS1/STGBOOLEAN /AWS1/STGBOOLEAN

Indicates whether AccessBasedEnumeration is enabled.

it_adminuserlist TYPE /AWS1/CL_STGUSERLIST_W=>TT_USERLIST TT_USERLIST

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.

it_validuserlist TYPE /AWS1/CL_STGUSERLIST_W=>TT_USERLIST TT_USERLIST

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.

it_invaliduserlist TYPE /AWS1/CL_STGUSERLIST_W=>TT_USERLIST TT_USERLIST

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.

iv_auditdestinationarn TYPE /AWS1/STGAUDITDESTINATIONARN /AWS1/STGAUDITDESTINATIONARN

The Amazon Resource Name (ARN) of the storage used for audit logs.

iv_authentication TYPE /AWS1/STGAUTHENTICATION /AWS1/STGAUTHENTICATION

Authentication

iv_casesensitivity TYPE /AWS1/STGCASESENSITIVITY /AWS1/STGCASESENSITIVITY

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.

it_tags TYPE /AWS1/CL_STGTAG=>TT_TAGS TT_TAGS

A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

iv_filesharename TYPE /AWS1/STGFILESHARENAME /AWS1/STGFILESHARENAME

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.

io_cacheattributes TYPE REF TO /AWS1/CL_STGCACHEATTRIBUTES /AWS1/CL_STGCACHEATTRIBUTES

Refresh cache information for the file share.

iv_notificationpolicy TYPE /AWS1/STGNOTIFICATIONPOLICY /AWS1/STGNOTIFICATIONPOLICY

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.

{}

iv_vpcendpointdnsname TYPE /AWS1/STGDNSHOSTNAME /AWS1/STGDNSHOSTNAME

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.

iv_bucketregion TYPE /AWS1/STGREGIONID /AWS1/STGREGIONID

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.

iv_oplocksenabled TYPE /AWS1/STGBOOLEAN /AWS1/STGBOOLEAN

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

---

Queryable Attributes

FileShareARN

FileShareARN

Accessible with the following methods

Method	Description
GET_FILESHAREARN()	Getter for FILESHAREARN, with configurable default
ASK_FILESHAREARN()	Getter for FILESHAREARN w/ exceptions if field has no value
HAS_FILESHAREARN()	Determine if FILESHAREARN has a value

FileShareId

FileShareId

Accessible with the following methods

Method	Description
GET_FILESHAREID()	Getter for FILESHAREID, with configurable default
ASK_FILESHAREID()	Getter for FILESHAREID w/ exceptions if field has no value
HAS_FILESHAREID()	Determine if FILESHAREID has a value

FileShareStatus

FileShareStatus

Accessible with the following methods

Method	Description
GET_FILESHARESTATUS()	Getter for FILESHARESTATUS, with configurable default
ASK_FILESHARESTATUS()	Getter for FILESHARESTATUS w/ exceptions if field has no val
HAS_FILESHARESTATUS()	Determine if FILESHARESTATUS has a value

GatewayARN

GatewayARN

Accessible with the following methods

Method	Description
GET_GATEWAYARN()	Getter for GATEWAYARN, with configurable default
ASK_GATEWAYARN()	Getter for GATEWAYARN w/ exceptions if field has no value
HAS_GATEWAYARN()	Determine if GATEWAYARN has a value

EncryptionType

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.

Accessible with the following methods

Method	Description
GET_ENCRYPTIONTYPE()	Getter for ENCRYPTIONTYPE, with configurable default
ASK_ENCRYPTIONTYPE()	Getter for ENCRYPTIONTYPE w/ exceptions if field has no valu
HAS_ENCRYPTIONTYPE()	Determine if ENCRYPTIONTYPE has a value

KMSEncrypted

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

Accessible with the following methods

Method	Description
GET_KMSENCRYPTED()	Getter for KMSENCRYPTED

KMSKey

KMSKey

Accessible with the following methods

Method	Description
GET_KMSKEY()	Getter for KMSKEY, with configurable default
ASK_KMSKEY()	Getter for KMSKEY w/ exceptions if field has no value
HAS_KMSKEY()	Determine if KMSKEY has a value

Path

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

Accessible with the following methods

Method	Description
GET_PATH()	Getter for PATH, with configurable default
ASK_PATH()	Getter for PATH w/ exceptions if field has no value
HAS_PATH()	Determine if PATH has a value

Role

Role

Accessible with the following methods

Method	Description
GET_ROLE()	Getter for ROLE, with configurable default
ASK_ROLE()	Getter for ROLE w/ exceptions if field has no value
HAS_ROLE()	Determine if ROLE has a value

LocationARN

LocationARN

Accessible with the following methods

Method	Description
GET_LOCATIONARN()	Getter for LOCATIONARN, with configurable default
ASK_LOCATIONARN()	Getter for LOCATIONARN w/ exceptions if field has no value
HAS_LOCATIONARN()	Determine if LOCATIONARN has a value

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

Accessible with the following methods

Method	Description
GET_DEFAULTSTORAGECLASS()	Getter for DEFAULTSTORAGECLASS, with configurable default
ASK_DEFAULTSTORAGECLASS()	Getter for DEFAULTSTORAGECLASS w/ exceptions if field has no
HAS_DEFAULTSTORAGECLASS()	Determine if DEFAULTSTORAGECLASS has a value

ObjectACL

ObjectACL

Accessible with the following methods

Method	Description
GET_OBJECTACL()	Getter for OBJECTACL, with configurable default
ASK_OBJECTACL()	Getter for OBJECTACL w/ exceptions if field has no value
HAS_OBJECTACL()	Determine if OBJECTACL has a value

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

Accessible with the following methods

Method	Description
GET_READONLY()	Getter for READONLY, with configurable default
ASK_READONLY()	Getter for READONLY w/ exceptions if field has no value
HAS_READONLY()	Determine if READONLY has a value

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

Accessible with the following methods

Method	Description
GET_GUESSMIMETYPEENABLED()	Getter for GUESSMIMETYPEENABLED, with configurable default
ASK_GUESSMIMETYPEENABLED()	Getter for GUESSMIMETYPEENABLED w/ exceptions if field has n
HAS_GUESSMIMETYPEENABLED()	Determine if GUESSMIMETYPEENABLED has a value

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

Accessible with the following methods

Method	Description
GET_REQUESTERPAYS()	Getter for REQUESTERPAYS, with configurable default
ASK_REQUESTERPAYS()	Getter for REQUESTERPAYS w/ exceptions if field has no value
HAS_REQUESTERPAYS()	Determine if REQUESTERPAYS has a value

SMBACLEnabled

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.

Accessible with the following methods

Method	Description
GET_SMBACLENABLED()	Getter for SMBACLENABLED, with configurable default
ASK_SMBACLENABLED()	Getter for SMBACLENABLED w/ exceptions if field has no value
HAS_SMBACLENABLED()	Determine if SMBACLENABLED has a value

AccessBasedEnumeration

Indicates whether AccessBasedEnumeration is enabled.

Accessible with the following methods

Method	Description
GET_ACCESSBASEDENUMERATION()	Getter for ACCESSBASEDENUMERATION, with configurable default
ASK_ACCESSBASEDENUMERATION()	Getter for ACCESSBASEDENUMERATION w/ exceptions if field has
HAS_ACCESSBASEDENUMERATION()	Determine if ACCESSBASEDENUMERATION has a value

AdminUserList

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.

Accessible with the following methods

Method	Description
GET_ADMINUSERLIST()	Getter for ADMINUSERLIST, with configurable default
ASK_ADMINUSERLIST()	Getter for ADMINUSERLIST w/ exceptions if field has no value
HAS_ADMINUSERLIST()	Determine if ADMINUSERLIST has a value

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.

Accessible with the following methods

Method	Description
GET_VALIDUSERLIST()	Getter for VALIDUSERLIST, with configurable default
ASK_VALIDUSERLIST()	Getter for VALIDUSERLIST w/ exceptions if field has no value
HAS_VALIDUSERLIST()	Determine if VALIDUSERLIST has a value

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.

Accessible with the following methods

Method	Description
GET_INVALIDUSERLIST()	Getter for INVALIDUSERLIST, with configurable default
ASK_INVALIDUSERLIST()	Getter for INVALIDUSERLIST w/ exceptions if field has no val
HAS_INVALIDUSERLIST()	Determine if INVALIDUSERLIST has a value

AuditDestinationARN

The Amazon Resource Name (ARN) of the storage used for audit logs.

Accessible with the following methods

Method	Description
GET_AUDITDESTINATIONARN()	Getter for AUDITDESTINATIONARN, with configurable default
ASK_AUDITDESTINATIONARN()	Getter for AUDITDESTINATIONARN w/ exceptions if field has no
HAS_AUDITDESTINATIONARN()	Determine if AUDITDESTINATIONARN has a value

Authentication

Authentication

Accessible with the following methods

Method	Description
GET_AUTHENTICATION()	Getter for AUTHENTICATION, with configurable default
ASK_AUTHENTICATION()	Getter for AUTHENTICATION w/ exceptions if field has no valu
HAS_AUTHENTICATION()	Determine if AUTHENTICATION has a value

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.

Accessible with the following methods

Method	Description
GET_CASESENSITIVITY()	Getter for CASESENSITIVITY, with configurable default
ASK_CASESENSITIVITY()	Getter for CASESENSITIVITY w/ exceptions if field has no val
HAS_CASESENSITIVITY()	Determine if CASESENSITIVITY has a value

Tags

A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Accessible with the following methods

Method	Description
GET_TAGS()	Getter for TAGS, with configurable default
ASK_TAGS()	Getter for TAGS w/ exceptions if field has no value
HAS_TAGS()	Determine if TAGS has a value

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.

Accessible with the following methods

Method	Description
GET_FILESHARENAME()	Getter for FILESHARENAME, with configurable default
ASK_FILESHARENAME()	Getter for FILESHARENAME w/ exceptions if field has no value
HAS_FILESHARENAME()	Determine if FILESHARENAME has a value

CacheAttributes

Refresh cache information for the file share.

Accessible with the following methods

Method	Description
GET_CACHEATTRIBUTES()	Getter for CACHEATTRIBUTES

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.

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.

{}

Accessible with the following methods

Method	Description
GET_NOTIFICATIONPOLICY()	Getter for NOTIFICATIONPOLICY, with configurable default
ASK_NOTIFICATIONPOLICY()	Getter for NOTIFICATIONPOLICY w/ exceptions if field has no
HAS_NOTIFICATIONPOLICY()	Determine if NOTIFICATIONPOLICY has a value

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.

Accessible with the following methods

Method	Description
GET_VPCENDPOINTDNSNAME()	Getter for VPCENDPOINTDNSNAME, with configurable default
ASK_VPCENDPOINTDNSNAME()	Getter for VPCENDPOINTDNSNAME w/ exceptions if field has no
HAS_VPCENDPOINTDNSNAME()	Determine if VPCENDPOINTDNSNAME has a value

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.

Accessible with the following methods

Method	Description
GET_BUCKETREGION()	Getter for BUCKETREGION, with configurable default
ASK_BUCKETREGION()	Getter for BUCKETREGION w/ exceptions if field has no value
HAS_BUCKETREGION()	Determine if BUCKETREGION has a value

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

Accessible with the following methods

Method	Description
GET_OPLOCKSENABLED()	Getter for OPLOCKSENABLED, with configurable default
ASK_OPLOCKSENABLED()	Getter for OPLOCKSENABLED w/ exceptions if field has no valu
HAS_OPLOCKSENABLED()	Determine if OPLOCKSENABLED has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_SMBFILESHAREINFOLIST

TYPES TT_SMBFILESHAREINFOLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_STGSMBFILESHAREINFO WITH DEFAULT KEY
.