| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::FSX::WindowsFileSystemConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has ActiveDirectoryId => (is => 'ro', isa => 'Str'); | ||
| 5 | has Aliases => (is => 'ro', isa => 'ArrayRef[Paws::FSX::Alias]'); | ||
| 6 | has AuditLogConfiguration => (is => 'ro', isa => 'Paws::FSX::WindowsAuditLogConfiguration'); | ||
| 7 | has AutomaticBackupRetentionDays => (is => 'ro', isa => 'Int'); | ||
| 8 | has CopyTagsToBackups => (is => 'ro', isa => 'Bool'); | ||
| 9 | has DailyAutomaticBackupStartTime => (is => 'ro', isa => 'Str'); | ||
| 10 | has DeploymentType => (is => 'ro', isa => 'Str'); | ||
| 11 | has MaintenanceOperationsInProgress => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 12 | has PreferredFileServerIp => (is => 'ro', isa => 'Str'); | ||
| 13 | has PreferredSubnetId => (is => 'ro', isa => 'Str'); | ||
| 14 | has RemoteAdministrationEndpoint => (is => 'ro', isa => 'Str'); | ||
| 15 | has SelfManagedActiveDirectoryConfiguration => (is => 'ro', isa => 'Paws::FSX::SelfManagedActiveDirectoryAttributes'); | ||
| 16 | has ThroughputCapacity => (is => 'ro', isa => 'Int'); | ||
| 17 | has WeeklyMaintenanceStartTime => (is => 'ro', isa => 'Str'); | ||
| 18 | |||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::FSX::WindowsFileSystemConfiguration | ||
| 26 | |||
| 27 | =head1 USAGE | ||
| 28 | |||
| 29 | This class represents one of two things: | ||
| 30 | |||
| 31 | =head3 Arguments in a call to a service | ||
| 32 | |||
| 33 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 34 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 35 | |||
| 36 | As an example, if Att1 is expected to be a Paws::FSX::WindowsFileSystemConfiguration object: | ||
| 37 | |||
| 38 | $service_obj->Method(Att1 => { ActiveDirectoryId => $value, ..., WeeklyMaintenanceStartTime => $value }); | ||
| 39 | |||
| 40 | =head3 Results returned from an API call | ||
| 41 | |||
| 42 | Use accessors for each attribute. If Att1 is expected to be an Paws::FSX::WindowsFileSystemConfiguration object: | ||
| 43 | |||
| 44 | $result = $service_obj->Method(...); | ||
| 45 | $result->Att1->ActiveDirectoryId | ||
| 46 | |||
| 47 | =head1 DESCRIPTION | ||
| 48 | |||
| 49 | The configuration for this Microsoft Windows file system. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 ActiveDirectoryId => Str | ||
| 55 | |||
| 56 | The ID for an existing AWS Managed Microsoft Active Directory instance | ||
| 57 | that the file system is joined to. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 Aliases => ArrayRef[L<Paws::FSX::Alias>] | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 AuditLogConfiguration => L<Paws::FSX::WindowsAuditLogConfiguration> | ||
| 66 | |||
| 67 | The configuration that Amazon FSx for Windows File Server uses to audit | ||
| 68 | and log user accesses of files, folders, and file shares on the Amazon | ||
| 69 | FSx for Windows File Server file system. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 AutomaticBackupRetentionDays => Int | ||
| 73 | |||
| 74 | The number of days to retain automatic backups. Setting this to 0 | ||
| 75 | disables automatic backups. You can retain automatic backups for a | ||
| 76 | maximum of 90 days. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 CopyTagsToBackups => Bool | ||
| 80 | |||
| 81 | A boolean flag indicating whether tags on the file system should be | ||
| 82 | copied to backups. This value defaults to false. If it's set to true, | ||
| 83 | all tags on the file system are copied to all automatic backups and any | ||
| 84 | user-initiated backups where the user doesn't specify any tags. If this | ||
| 85 | value is true, and you specify one or more tags, only the specified | ||
| 86 | tags are copied to backups. If you specify one or more tags when | ||
| 87 | creating a user-initiated backup, no tags are copied from the file | ||
| 88 | system, regardless of this value. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 DailyAutomaticBackupStartTime => Str | ||
| 92 | |||
| 93 | The preferred time to take daily automatic backups, in the UTC time | ||
| 94 | zone. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 DeploymentType => Str | ||
| 98 | |||
| 99 | Specifies the file system deployment type, valid values are the | ||
| 100 | following: | ||
| 101 | |||
| 102 | =over | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | C<MULTI_AZ_1> - Specifies a high availability file system that is | ||
| 107 | configured for Multi-AZ redundancy to tolerate temporary Availability | ||
| 108 | Zone (AZ) unavailability, and supports SSD and HDD storage. | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | C<SINGLE_AZ_1> - (Default) Specifies a file system that is configured | ||
| 113 | for single AZ redundancy, only supports SSD storage. | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | C<SINGLE_AZ_2> - Latest generation Single AZ file system. Specifies a | ||
| 118 | file system that is configured for single AZ redundancy and supports | ||
| 119 | SSD and HDD storage. | ||
| 120 | |||
| 121 | =back | ||
| 122 | |||
| 123 | For more information, see Single-AZ and Multi-AZ File Systems | ||
| 124 | (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html). | ||
| 125 | |||
| 126 | |||
| 127 | =head2 MaintenanceOperationsInProgress => ArrayRef[Str|Undef] | ||
| 128 | |||
| 129 | The list of maintenance operations in progress for this file system. | ||
| 130 | |||
| 131 | |||
| 132 | =head2 PreferredFileServerIp => Str | ||
| 133 | |||
| 134 | For C<MULTI_AZ_1> deployment types, the IP address of the primary, or | ||
| 135 | preferred, file server. | ||
| 136 | |||
| 137 | Use this IP address when mounting the file system on Linux SMB clients | ||
| 138 | or Windows SMB clients that are not joined to a Microsoft Active | ||
| 139 | Directory. Applicable for all Windows file system deployment types. | ||
| 140 | This IP address is temporarily unavailable when the file system is | ||
| 141 | undergoing maintenance. For Linux and Windows SMB clients that are | ||
| 142 | joined to an Active Directory, use the file system's DNSName instead. | ||
| 143 | For more information on mapping and mounting file shares, see Accessing | ||
| 144 | File Shares | ||
| 145 | (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html). | ||
| 146 | |||
| 147 | |||
| 148 | =head2 PreferredSubnetId => Str | ||
| 149 | |||
| 150 | For C<MULTI_AZ_1> deployment types, it specifies the ID of the subnet | ||
| 151 | where the preferred file server is located. Must be one of the two | ||
| 152 | subnet IDs specified in C<SubnetIds> property. Amazon FSx serves | ||
| 153 | traffic from this subnet except in the event of a failover to the | ||
| 154 | secondary file server. | ||
| 155 | |||
| 156 | For C<SINGLE_AZ_1> and C<SINGLE_AZ_2> deployment types, this value is | ||
| 157 | the same as that for C<SubnetIDs>. For more information, see | ||
| 158 | Availability and durability: Single-AZ and Multi-AZ file systems | ||
| 159 | (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html#single-multi-az-resources). | ||
| 160 | |||
| 161 | |||
| 162 | =head2 RemoteAdministrationEndpoint => Str | ||
| 163 | |||
| 164 | For C<MULTI_AZ_1> deployment types, use this endpoint when performing | ||
| 165 | administrative tasks on the file system using Amazon FSx Remote | ||
| 166 | PowerShell. | ||
| 167 | |||
| 168 | For C<SINGLE_AZ_1> and C<SINGLE_AZ_2> deployment types, this is the DNS | ||
| 169 | name of the file system. | ||
| 170 | |||
| 171 | This endpoint is temporarily unavailable when the file system is | ||
| 172 | undergoing maintenance. | ||
| 173 | |||
| 174 | |||
| 175 | =head2 SelfManagedActiveDirectoryConfiguration => L<Paws::FSX::SelfManagedActiveDirectoryAttributes> | ||
| 176 | |||
| 177 | |||
| 178 | |||
| 179 | |||
| 180 | =head2 ThroughputCapacity => Int | ||
| 181 | |||
| 182 | The throughput of the Amazon FSx file system, measured in megabytes per | ||
| 183 | second. | ||
| 184 | |||
| 185 | |||
| 186 | =head2 WeeklyMaintenanceStartTime => Str | ||
| 187 | |||
| 188 | The preferred start time to perform weekly maintenance, formatted | ||
| 189 | d:HH:MM in the UTC time zone. d is the weekday number, from 1 through | ||
| 190 | 7, beginning with Monday and ending with Sunday. | ||
| 191 | |||
| 192 | |||
| 193 | |||
| 194 | =head1 SEE ALSO | ||
| 195 | |||
| 196 | This class forms part of L<Paws>, describing an object used in L<Paws::FSX> | ||
| 197 | |||
| 198 | =head1 BUGS and CONTRIBUTIONS | ||
| 199 | |||
| 200 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 201 | |||
| 202 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 203 | |||
| 204 | =cut | ||
| 205 |