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',
AdminUserList => [
'MyFileShareUser', ... # min: 1, max: 64
], # OPTIONAL
DefaultStorageClass => 'MyStorageClass', # OPTIONAL
GuessMIMETypeEnabled => 1, # OPTIONAL
InvalidUserList => [
'MyFileShareUser', ... # min: 1, max: 64
], # OPTIONAL
KMSEncrypted => 1, # OPTIONAL
KMSKey => 'MyKMSKey', # OPTIONAL
ObjectACL => 'private', # OPTIONAL
ReadOnly => 1, # OPTIONAL
RequesterPays => 1, # OPTIONAL
SMBACLEnabled => 1, # OPTIONAL
ValidUserList => [
'MyFileShareUser', ... # 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
AdminUserList => ArrayRef[Str|Undef]
A list of users in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
DefaultStorageClass => Str
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.
REQUIRED FileShareARN => Str
The Amazon Resource Name (ARN) of the SMB file share that you want to update.
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, and otherwise to false. The default value is true.
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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
KMSEncrypted => Bool
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.
KMSKey => Str
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.
ObjectACL => Str
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".
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. This value is true if the write status is read-only, and otherwise 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.
SMBACLEnabled => Bool
Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.
For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.htmlin the Storage Gateway User Guide.
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. For example @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