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