NAME
Paws::StorageGateway::SMBFileShareInfo
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::StorageGateway::SMBFileShareInfo object:
$service_obj->Method(Att1 => { AccessBasedEnumeration => $value, ..., ValidUserList => $value });Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::StorageGateway::SMBFileShareInfo object:
$result = $service_obj->Method(...);
$result->Att1->AccessBasedEnumerationDESCRIPTION
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.
ATTRIBUTES
AccessBasedEnumeration => Bool
Indicates whether AccessBasedEnumeration is enabled.
AdminUserList => ArrayRef[Str|Undef]
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.
AuditDestinationARN => Str
The Amazon Resource Name (ARN) of the storage used for audit logs.
Authentication => Str
CacheAttributes => Paws::StorageGateway::CacheAttributes
Refresh cache information for the file share.
CaseSensitivity => Str
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 => Str
The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
FileShareARN => Str
FileShareId => Str
FileShareName => Str
The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in LocationARN.
FileShareStatus => Str
GatewayARN => Str
GuessMIMETypeEnabled => Bool
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 => ArrayRef[Str|Undef]
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 => Bool
Set to 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.
Valid Values: true | false
KMSKey => Str
LocationARN => Str
NotificationPolicy => Str
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 => Str
Path => Str
The file share path used by the SMB client to identify the mount point.
ReadOnly => 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
RequesterPays => 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
Role => Str
SMBACLEnabled => Bool
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 Microsoft Windows ACLs to control access to an SMB file share (https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html) in the AWS Storage Gateway User Guide.
Tags => ArrayRef[Paws::StorageGateway::Tag]
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.
ValidUserList => ArrayRef[Str|Undef]
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.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::StorageGateway
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues