« blib/lib/Paws/StorageGateway/UpdateNFSFileShareOutput.pm
↑ Summary
blib/lib/Paws/StorageGateway/UpdateSMBFileShareOutput.pm »
| 1 | |||
| 2 | package Paws::StorageGateway::UpdateSMBFileShare; | ||
| 3 | use Moose; | ||
| 4 | has AccessBasedEnumeration => (is => 'ro', isa => 'Bool'); | ||
| 5 | has AdminUserList => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has AuditDestinationARN => (is => 'ro', isa => 'Str'); | ||
| 7 | has CacheAttributes => (is => 'ro', isa => 'Paws::StorageGateway::CacheAttributes'); | ||
| 8 | has CaseSensitivity => (is => 'ro', isa => 'Str'); | ||
| 9 | has DefaultStorageClass => (is => 'ro', isa => 'Str'); | ||
| 10 | has FileShareARN => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has FileShareName => (is => 'ro', isa => 'Str'); | ||
| 12 | has GuessMIMETypeEnabled => (is => 'ro', isa => 'Bool'); | ||
| 13 | has InvalidUserList => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 14 | has KMSEncrypted => (is => 'ro', isa => 'Bool'); | ||
| 15 | has KMSKey => (is => 'ro', isa => 'Str'); | ||
| 16 | has NotificationPolicy => (is => 'ro', isa => 'Str'); | ||
| 17 | has ObjectACL => (is => 'ro', isa => 'Str'); | ||
| 18 | has ReadOnly => (is => 'ro', isa => 'Bool'); | ||
| 19 | has RequesterPays => (is => 'ro', isa => 'Bool'); | ||
| 20 | has SMBACLEnabled => (is => 'ro', isa => 'Bool'); | ||
| 21 | has ValidUserList => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 22 | |||
| 23 | use MooseX::ClassAttribute; | ||
| 24 | |||
| 25 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateSMBFileShare'); | ||
| 26 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::StorageGateway::UpdateSMBFileShareOutput'); | ||
| 27 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 28 | 1; | ||
| 29 | |||
| 30 | ### main pod documentation begin ### | ||
| 31 | |||
| 32 | =head1 NAME | ||
| 33 | |||
| 34 | Paws::StorageGateway::UpdateSMBFileShare - Arguments for method UpdateSMBFileShare on L<Paws::StorageGateway> | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | This class represents the parameters used for calling the method UpdateSMBFileShare on the | ||
| 39 | L<AWS Storage Gateway|Paws::StorageGateway> service. Use the attributes of this class | ||
| 40 | as arguments to method UpdateSMBFileShare. | ||
| 41 | |||
| 42 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateSMBFileShare. | ||
| 43 | |||
| 44 | =head1 SYNOPSIS | ||
| 45 | |||
| 46 | my $storagegateway = Paws->service('StorageGateway'); | ||
| 47 | my $UpdateSMBFileShareOutput = $storagegateway->UpdateSMBFileShare( | ||
| 48 | FileShareARN => 'MyFileShareARN', | ||
| 49 | AccessBasedEnumeration => 1, # OPTIONAL | ||
| 50 | AdminUserList => [ | ||
| 51 | 'MyUserListUser', ... # min: 1, max: 64 | ||
| 52 | ], # OPTIONAL | ||
| 53 | AuditDestinationARN => 'MyAuditDestinationARN', # OPTIONAL | ||
| 54 | CacheAttributes => { | ||
| 55 | CacheStaleTimeoutInSeconds => 1, # OPTIONAL | ||
| 56 | }, # OPTIONAL | ||
| 57 | CaseSensitivity => 'ClientSpecified', # OPTIONAL | ||
| 58 | DefaultStorageClass => 'MyStorageClass', # OPTIONAL | ||
| 59 | FileShareName => 'MyFileShareName', # OPTIONAL | ||
| 60 | GuessMIMETypeEnabled => 1, # OPTIONAL | ||
| 61 | InvalidUserList => [ | ||
| 62 | 'MyUserListUser', ... # min: 1, max: 64 | ||
| 63 | ], # OPTIONAL | ||
| 64 | KMSEncrypted => 1, # OPTIONAL | ||
| 65 | KMSKey => 'MyKMSKey', # OPTIONAL | ||
| 66 | NotificationPolicy => 'MyNotificationPolicy', # OPTIONAL | ||
| 67 | ObjectACL => 'private', # OPTIONAL | ||
| 68 | ReadOnly => 1, # OPTIONAL | ||
| 69 | RequesterPays => 1, # OPTIONAL | ||
| 70 | SMBACLEnabled => 1, # OPTIONAL | ||
| 71 | ValidUserList => [ | ||
| 72 | 'MyUserListUser', ... # min: 1, max: 64 | ||
| 73 | ], # OPTIONAL | ||
| 74 | ); | ||
| 75 | |||
| 76 | # Results: | ||
| 77 | my $FileShareARN = $UpdateSMBFileShareOutput->FileShareARN; | ||
| 78 | |||
| 79 | # Returns a L<Paws::StorageGateway::UpdateSMBFileShareOutput> object. | ||
| 80 | |||
| 81 | 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. | ||
| 82 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/storagegateway/UpdateSMBFileShare> | ||
| 83 | |||
| 84 | =head1 ATTRIBUTES | ||
| 85 | |||
| 86 | |||
| 87 | =head2 AccessBasedEnumeration => Bool | ||
| 88 | |||
| 89 | The files and folders on this share will only be visible to users with | ||
| 90 | read access. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 AdminUserList => ArrayRef[Str|Undef] | ||
| 95 | |||
| 96 | A list of users or groups in the Active Directory that have | ||
| 97 | administrator rights to the file share. A group must be prefixed with | ||
| 98 | the @ character. Acceptable formats include: C<DOMAIN\User1>, C<user1>, | ||
| 99 | C<@group1>, and C<@DOMAIN\group1>. Can only be set if Authentication is | ||
| 100 | set to C<ActiveDirectory>. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 AuditDestinationARN => Str | ||
| 105 | |||
| 106 | The Amazon Resource Name (ARN) of the storage used for audit logs. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 CacheAttributes => L<Paws::StorageGateway::CacheAttributes> | ||
| 111 | |||
| 112 | Specifies refresh cache information for the file share. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 CaseSensitivity => Str | ||
| 117 | |||
| 118 | The case of an object name in an Amazon S3 bucket. For | ||
| 119 | C<ClientSpecified>, the client determines the case sensitivity. For | ||
| 120 | C<CaseSensitive>, the gateway determines the case sensitivity. The | ||
| 121 | default value is C<ClientSpecified>. | ||
| 122 | |||
| 123 | Valid values are: C<"ClientSpecified">, C<"CaseSensitive"> | ||
| 124 | |||
| 125 | =head2 DefaultStorageClass => Str | ||
| 126 | |||
| 127 | The default storage class for objects put into an Amazon S3 bucket by | ||
| 128 | the file gateway. The default value is C<S3_INTELLIGENT_TIERING>. | ||
| 129 | Optional. | ||
| 130 | |||
| 131 | Valid Values: C<S3_STANDARD> | C<S3_INTELLIGENT_TIERING> | | ||
| 132 | C<S3_STANDARD_IA> | C<S3_ONEZONE_IA> | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 B<REQUIRED> FileShareARN => Str | ||
| 137 | |||
| 138 | The Amazon Resource Name (ARN) of the SMB file share that you want to | ||
| 139 | update. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head2 FileShareName => Str | ||
| 144 | |||
| 145 | The name of the file share. Optional. | ||
| 146 | |||
| 147 | C<FileShareName> must be set if an S3 prefix name is set in | ||
| 148 | C<LocationARN>. | ||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head2 GuessMIMETypeEnabled => Bool | ||
| 153 | |||
| 154 | A value that enables guessing of the MIME type for uploaded objects | ||
| 155 | based on file extensions. Set this value to C<true> to enable MIME type | ||
| 156 | guessing, otherwise set to C<false>. The default value is C<true>. | ||
| 157 | |||
| 158 | Valid Values: C<true> | C<false> | ||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | =head2 InvalidUserList => ArrayRef[Str|Undef] | ||
| 163 | |||
| 164 | A list of users or groups in the Active Directory that are not allowed | ||
| 165 | to access the file share. A group must be prefixed with the @ | ||
| 166 | character. Acceptable formats include: C<DOMAIN\User1>, C<user1>, | ||
| 167 | C<@group1>, and C<@DOMAIN\group1>. Can only be set if Authentication is | ||
| 168 | set to C<ActiveDirectory>. | ||
| 169 | |||
| 170 | |||
| 171 | |||
| 172 | =head2 KMSEncrypted => Bool | ||
| 173 | |||
| 174 | Set to C<true> to use Amazon S3 server-side encryption with your own | ||
| 175 | AWS KMS key, or C<false> to use a key managed by Amazon S3. Optional. | ||
| 176 | |||
| 177 | Valid Values: C<true> | C<false> | ||
| 178 | |||
| 179 | |||
| 180 | |||
| 181 | =head2 KMSKey => Str | ||
| 182 | |||
| 183 | The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) | ||
| 184 | used for Amazon S3 server-side encryption. Storage Gateway does not | ||
| 185 | support asymmetric CMKs. This value can only be set when | ||
| 186 | C<KMSEncrypted> is C<true>. Optional. | ||
| 187 | |||
| 188 | |||
| 189 | |||
| 190 | =head2 NotificationPolicy => Str | ||
| 191 | |||
| 192 | The notification policy of the file share. C<SettlingTimeInSeconds> | ||
| 193 | controls the number of seconds to wait after the last point in time a | ||
| 194 | client wrote to a file before generating an C<ObjectUploaded> | ||
| 195 | notification. Because clients can make many small writes to files, it's | ||
| 196 | best to set this parameter for as long as possible to avoid generating | ||
| 197 | multiple notifications for the same file in a small time period. | ||
| 198 | |||
| 199 | C<SettlingTimeInSeconds> has no effect on the timing of the object | ||
| 200 | uploading to Amazon S3, only the timing of the notification. | ||
| 201 | |||
| 202 | The following example sets C<NotificationPolicy> on with | ||
| 203 | C<SettlingTimeInSeconds> set to 60. | ||
| 204 | |||
| 205 | C<{\"Upload\": {\"SettlingTimeInSeconds\": 60}}> | ||
| 206 | |||
| 207 | The following example sets C<NotificationPolicy> off. | ||
| 208 | |||
| 209 | C<{}> | ||
| 210 | |||
| 211 | |||
| 212 | |||
| 213 | =head2 ObjectACL => Str | ||
| 214 | |||
| 215 | A value that sets the access control list (ACL) permission for objects | ||
| 216 | in the S3 bucket that a file gateway puts objects into. The default | ||
| 217 | value is C<private>. | ||
| 218 | |||
| 219 | Valid values are: C<"private">, C<"public-read">, C<"public-read-write">, C<"authenticated-read">, C<"bucket-owner-read">, C<"bucket-owner-full-control">, C<"aws-exec-read"> | ||
| 220 | |||
| 221 | =head2 ReadOnly => Bool | ||
| 222 | |||
| 223 | A value that sets the write status of a file share. Set this value to | ||
| 224 | C<true> to set write status to read-only, otherwise set to C<false>. | ||
| 225 | |||
| 226 | Valid Values: C<true> | C<false> | ||
| 227 | |||
| 228 | |||
| 229 | |||
| 230 | =head2 RequesterPays => Bool | ||
| 231 | |||
| 232 | A value that sets who pays the cost of the request and the cost | ||
| 233 | associated with data download from the S3 bucket. If this value is set | ||
| 234 | to C<true>, the requester pays the costs; otherwise, the S3 bucket | ||
| 235 | owner pays. However, the S3 bucket owner always pays the cost of | ||
| 236 | storing data. | ||
| 237 | |||
| 238 | C<RequesterPays> is a configuration for the S3 bucket that backs the | ||
| 239 | file share, so make sure that the configuration on the file share is | ||
| 240 | the same as the S3 bucket configuration. | ||
| 241 | |||
| 242 | Valid Values: C<true> | C<false> | ||
| 243 | |||
| 244 | |||
| 245 | |||
| 246 | =head2 SMBACLEnabled => Bool | ||
| 247 | |||
| 248 | Set this value to C<true> to enable access control list (ACL) on the | ||
| 249 | SMB file share. Set it to C<false> to map file and directory | ||
| 250 | permissions to the POSIX permissions. | ||
| 251 | |||
| 252 | For more information, see Using Microsoft Windows ACLs to control | ||
| 253 | access to an SMB file share | ||
| 254 | (https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html) | ||
| 255 | in the I<AWS Storage Gateway User Guide>. | ||
| 256 | |||
| 257 | Valid Values: C<true> | C<false> | ||
| 258 | |||
| 259 | |||
| 260 | |||
| 261 | =head2 ValidUserList => ArrayRef[Str|Undef] | ||
| 262 | |||
| 263 | A list of users or groups in the Active Directory that are allowed to | ||
| 264 | access the file share. A group must be prefixed with the @ character. | ||
| 265 | Acceptable formats include: C<DOMAIN\User1>, C<user1>, C<@group1>, and | ||
| 266 | C<@DOMAIN\group1>. Can only be set if Authentication is set to | ||
| 267 | C<ActiveDirectory>. | ||
| 268 | |||
| 269 | |||
| 270 | |||
| 271 | |||
| 272 | =head1 SEE ALSO | ||
| 273 | |||
| 274 | This class forms part of L<Paws>, documenting arguments for method UpdateSMBFileShare in L<Paws::StorageGateway> | ||
| 275 | |||
| 276 | =head1 BUGS and CONTRIBUTIONS | ||
| 277 | |||
| 278 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 279 | |||
| 280 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 281 | |||
| 282 | =cut | ||
| 283 |