/AWS1/CL_STGNFSFILESHAREINFO

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

CONSTRUCTOR

IMPORTING

Optional arguments:

io_nfsfilesharedefaults TYPE REF TO /AWS1/CL_STGNFSFILESHAREDEFS /AWS1/CL_STGNFSFILESHAREDEFS

Describes Network File System (NFS) file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported for S3 File Gateways.

iv_filesharearn TYPE /AWS1/STGFILESHAREARN /AWS1/STGFILESHAREARN

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

iv_fileshareid TYPE /AWS1/STGFILESHAREID /AWS1/STGFILESHAREID

The ID of the file share.

iv_filesharestatus TYPE /AWS1/STGFILESHARESTATUS /AWS1/STGFILESHARESTATUS

The status of the file share.

Valid Values: CREATING | UPDATING | AVAILABLE | DELETING

iv_gatewayarn TYPE /AWS1/STGGATEWAYARN /AWS1/STGGATEWAYARN

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

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

Optional. 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 must be set if KMSEncrypted is true, or if EncryptionType is SseKms or DsseKms.

iv_path TYPE /AWS1/STGPATH /AWS1/STGPATH

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

iv_role TYPE /AWS1/STGROLE /AWS1/STGROLE

The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.

iv_locationarn TYPE /AWS1/STGLOCATIONARN /AWS1/STGLOCATIONARN

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:::amzn-s3-demo-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 Delegating access control to access points in the Amazon S3 User Guide.

Access point alias:

test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

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

A value that sets the access control list (ACL) permission for objects in the S3 bucket that an S3 File Gateway puts objects into. The default value is private.

it_clientlist TYPE /AWS1/CL_STGFILESHARECLILIST_W=>TT_FILESHARECLIENTLIST TT_FILESHARECLIENTLIST

The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IPv4/IPv6 addresses or valid CIDR blocks.

iv_squash TYPE /AWS1/STGSQUASH /AWS1/STGSQUASH

The user mapped to anonymous user. Valid options are the following:

• RootSquash: Only root is mapped to anonymous user.

• NoSquash: No one is mapped to anonymous user.

• AllSquash: Everyone is mapped to anonymous user.

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

it_tags TYPE /AWS1/CL_STGTAG=>TT_TAGS TT_TAGS

A list of up to 50 tags assigned to the NFS 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 NFS file share uses to connect to Amazon S3.

This parameter is required for NFS 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 NFS file share stores files.

This parameter is required for NFS 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_auditdestinationarn TYPE /AWS1/STGAUDITDESTINATIONARN /AWS1/STGAUDITDESTINATIONARN

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

---

Queryable Attributes

NFSFileShareDefaults

Describes Network File System (NFS) file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported for S3 File Gateways.

Accessible with the following methods

Method	Description
GET_NFSFILESHAREDEFAULTS()	Getter for NFSFILESHAREDEFAULTS

FileShareARN

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

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

The ID of the file share.

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

The status of the file share.

Valid Values: CREATING | UPDATING | AVAILABLE | DELETING

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

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

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

Optional. 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 must be set if KMSEncrypted is true, or if EncryptionType is SseKms or DsseKms.

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 NFS 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

The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.

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

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:::amzn-s3-demo-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 Delegating access control to access points in the Amazon S3 User Guide.

Access point alias:

test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

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

A value that sets the access control list (ACL) permission for objects in the S3 bucket that an S3 File Gateway puts objects into. The default value is private.

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

ClientList

The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IPv4/IPv6 addresses or valid CIDR blocks.

Accessible with the following methods

Method	Description
GET_CLIENTLIST()	Getter for CLIENTLIST, with configurable default
ASK_CLIENTLIST()	Getter for CLIENTLIST w/ exceptions if field has no value
HAS_CLIENTLIST()	Determine if CLIENTLIST has a value

Squash

The user mapped to anonymous user. Valid options are the following:

• RootSquash: Only root is mapped to anonymous user.

• NoSquash: No one is mapped to anonymous user.

• AllSquash: Everyone is mapped to anonymous user.

Accessible with the following methods

Method	Description
GET_SQUASH()	Getter for SQUASH, with configurable default
ASK_SQUASH()	Getter for SQUASH w/ exceptions if field has no value
HAS_SQUASH()	Determine if SQUASH 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

Tags

A list of up to 50 tags assigned to the NFS 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 NFS file share uses to connect to Amazon S3.

This parameter is required for NFS 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 NFS file share stores files.

This parameter is required for NFS 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

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

Public Local Types In This Class

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

TT_NFSFILESHAREINFOLIST

TYPES TT_NFSFILESHAREINFOLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_STGNFSFILESHAREINFO WITH DEFAULT KEY
.