NAME
Paws::StorageGateway::UpdateSMBFileShare - Arguments for method UpdateSMBFileShare on Paws::StorageGateway
DESCRIPTION
This class represents the parameters used for calling the method UpdateSMBFileShare on the AWS Storage Gateway service. Use the attributes of this class as arguments to method UpdateSMBFileShare.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateSMBFileShare.
SYNOPSIS
my $storagegateway = Paws->service('StorageGateway');
my $UpdateSMBFileShareOutput = $storagegateway->UpdateSMBFileShare(
FileShareARN => 'MyFileShareARN',
AccessBasedEnumeration => 1, # OPTIONAL
AdminUserList => [
'MyUserListUser', ... # min: 1, max: 64
], # OPTIONAL
AuditDestinationARN => 'MyAuditDestinationARN', # OPTIONAL
CacheAttributes => {
CacheStaleTimeoutInSeconds => 1, # OPTIONAL
}, # OPTIONAL
CaseSensitivity => 'ClientSpecified', # OPTIONAL
DefaultStorageClass => 'MyStorageClass', # OPTIONAL
FileShareName => 'MyFileShareName', # OPTIONAL
GuessMIMETypeEnabled => 1, # OPTIONAL
InvalidUserList => [
'MyUserListUser', ... # min: 1, max: 64
], # OPTIONAL
KMSEncrypted => 1, # OPTIONAL
KMSKey => 'MyKMSKey', # OPTIONAL
NotificationPolicy => 'MyNotificationPolicy', # OPTIONAL
ObjectACL => 'private', # OPTIONAL
ReadOnly => 1, # OPTIONAL
RequesterPays => 1, # OPTIONAL
SMBACLEnabled => 1, # OPTIONAL
ValidUserList => [
'MyUserListUser', ... # min: 1, max: 64
], # OPTIONAL
);
# Results:
my $FileShareARN = $UpdateSMBFileShareOutput->FileShareARN;
# Returns a L<Paws::StorageGateway::UpdateSMBFileShareOutput> object.Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/storagegateway/UpdateSMBFileShare
ATTRIBUTES
AccessBasedEnumeration => Bool
The files and folders on this share will only be visible to users with read access.
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.
CacheAttributes => Paws::StorageGateway::CacheAttributes
Specifies 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.
Valid values are: "ClientSpecified", "CaseSensitive"
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
REQUIRED FileShareARN => Str
The Amazon Resource Name (ARN) of the SMB file share that you want to update.
FileShareName => Str
The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in LocationARN.
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
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 can only be set when KMSEncrypted is true. Optional.
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
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private.
Valid values are: "private", "public-read", "public-read-write", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control", "aws-exec-read"
ReadOnly => Bool
A value that sets the write status of a file share. Set this value to true to set 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
SMBACLEnabled => Bool
Set this value to true to enable access control list (ACL) on the SMB file share. Set it to false to map file and directory permissions to the POSIX permissions.
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.
Valid Values: true | false
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, documenting arguments for method UpdateSMBFileShare 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