« blib/lib/Paws/FSX/DisassociateFileSystemAliasesResponse.pm
↑ Summary
blib/lib/Paws/FSX/FileSystemFailureDetails.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::FSX::FileSystem; | ||
| 3 | use Moose; | ||
| 4 | has AdministrativeActions => (is => 'ro', isa => 'ArrayRef[Paws::FSX::AdministrativeAction]'); | ||
| 5 | has CreationTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has DNSName => (is => 'ro', isa => 'Str'); | ||
| 7 | has FailureDetails => (is => 'ro', isa => 'Paws::FSX::FileSystemFailureDetails'); | ||
| 8 | has FileSystemId => (is => 'ro', isa => 'Str'); | ||
| 9 | has FileSystemType => (is => 'ro', isa => 'Str'); | ||
| 10 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 11 | has Lifecycle => (is => 'ro', isa => 'Str'); | ||
| 12 | has LustreConfiguration => (is => 'ro', isa => 'Paws::FSX::LustreFileSystemConfiguration'); | ||
| 13 | has NetworkInterfaceIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 14 | has OwnerId => (is => 'ro', isa => 'Str'); | ||
| 15 | has ResourceARN => (is => 'ro', isa => 'Str'); | ||
| 16 | has StorageCapacity => (is => 'ro', isa => 'Int'); | ||
| 17 | has StorageType => (is => 'ro', isa => 'Str'); | ||
| 18 | has SubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 19 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::FSX::Tag]'); | ||
| 20 | has VpcId => (is => 'ro', isa => 'Str'); | ||
| 21 | has WindowsConfiguration => (is => 'ro', isa => 'Paws::FSX::WindowsFileSystemConfiguration'); | ||
| 22 | |||
| 23 | 1; | ||
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::FSX::FileSystem | ||
| 30 | |||
| 31 | =head1 USAGE | ||
| 32 | |||
| 33 | This class represents one of two things: | ||
| 34 | |||
| 35 | =head3 Arguments in a call to a service | ||
| 36 | |||
| 37 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 38 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 39 | |||
| 40 | As an example, if Att1 is expected to be a Paws::FSX::FileSystem object: | ||
| 41 | |||
| 42 | $service_obj->Method(Att1 => { AdministrativeActions => $value, ..., WindowsConfiguration => $value }); | ||
| 43 | |||
| 44 | =head3 Results returned from an API call | ||
| 45 | |||
| 46 | Use accessors for each attribute. If Att1 is expected to be an Paws::FSX::FileSystem object: | ||
| 47 | |||
| 48 | $result = $service_obj->Method(...); | ||
| 49 | $result->Att1->AdministrativeActions | ||
| 50 | |||
| 51 | =head1 DESCRIPTION | ||
| 52 | |||
| 53 | A description of a specific Amazon FSx file system. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 AdministrativeActions => ArrayRef[L<Paws::FSX::AdministrativeAction>] | ||
| 59 | |||
| 60 | A list of administrative actions for the file system that are in | ||
| 61 | process or waiting to be processed. Administrative actions describe | ||
| 62 | changes to the Windows file system that you have initiated using the | ||
| 63 | C<UpdateFileSystem> action. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 CreationTime => Str | ||
| 67 | |||
| 68 | The time that the file system was created, in seconds (since | ||
| 69 | 1970-01-01T00:00:00Z), also known as Unix time. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 DNSName => Str | ||
| 73 | |||
| 74 | The DNS name for the file system. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 FailureDetails => L<Paws::FSX::FileSystemFailureDetails> | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 FileSystemId => Str | ||
| 83 | |||
| 84 | The system-generated, unique 17-digit ID of the file system. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 FileSystemType => Str | ||
| 88 | |||
| 89 | The type of Amazon FSx file system, either C<LUSTRE> or C<WINDOWS>. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 KmsKeyId => Str | ||
| 93 | |||
| 94 | The ID of the AWS Key Management Service (AWS KMS) key used to encrypt | ||
| 95 | the file system's data for Amazon FSx for Windows File Server file | ||
| 96 | systems and persistent Amazon FSx for Lustre file systems at rest. In | ||
| 97 | either case, if not specified, the Amazon FSx managed key is used. The | ||
| 98 | scratch Amazon FSx for Lustre file systems are always encrypted at rest | ||
| 99 | using Amazon FSx managed keys. For more information, see Encrypt | ||
| 100 | (https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) | ||
| 101 | in the I<AWS Key Management Service API Reference>. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 Lifecycle => Str | ||
| 105 | |||
| 106 | The lifecycle status of the file system, following are the possible | ||
| 107 | values and what they mean: | ||
| 108 | |||
| 109 | =over | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | C<AVAILABLE> - The file system is in a healthy state, and is reachable | ||
| 114 | and available for use. | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | C<CREATING> - Amazon FSx is creating the new file system. | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | C<DELETING> - Amazon FSx is deleting an existing file system. | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | C<FAILED> - An existing file system has experienced an unrecoverable | ||
| 127 | failure. When creating a new file system, Amazon FSx was unable to | ||
| 128 | create the file system. | ||
| 129 | |||
| 130 | =item * | ||
| 131 | |||
| 132 | C<MISCONFIGURED> indicates that the file system is in a failed but | ||
| 133 | recoverable state. | ||
| 134 | |||
| 135 | =item * | ||
| 136 | |||
| 137 | C<UPDATING> indicates that the file system is undergoing a customer | ||
| 138 | initiated update. | ||
| 139 | |||
| 140 | =back | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head2 LustreConfiguration => L<Paws::FSX::LustreFileSystemConfiguration> | ||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head2 NetworkInterfaceIds => ArrayRef[Str|Undef] | ||
| 150 | |||
| 151 | The IDs of the elastic network interface from which a specific file | ||
| 152 | system is accessible. The elastic network interface is automatically | ||
| 153 | created in the same VPC that the Amazon FSx file system was created in. | ||
| 154 | For more information, see Elastic Network Interfaces | ||
| 155 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html) in | ||
| 156 | the I<Amazon EC2 User Guide.> | ||
| 157 | |||
| 158 | For an Amazon FSx for Windows File Server file system, you can have one | ||
| 159 | network interface ID. For an Amazon FSx for Lustre file system, you can | ||
| 160 | have more than one. | ||
| 161 | |||
| 162 | |||
| 163 | =head2 OwnerId => Str | ||
| 164 | |||
| 165 | The AWS account that created the file system. If the file system was | ||
| 166 | created by an AWS Identity and Access Management (IAM) user, the AWS | ||
| 167 | account to which the IAM user belongs is the owner. | ||
| 168 | |||
| 169 | |||
| 170 | =head2 ResourceARN => Str | ||
| 171 | |||
| 172 | The Amazon Resource Name (ARN) for the file system resource. | ||
| 173 | |||
| 174 | |||
| 175 | =head2 StorageCapacity => Int | ||
| 176 | |||
| 177 | The storage capacity of the file system in gibibytes (GiB). | ||
| 178 | |||
| 179 | |||
| 180 | =head2 StorageType => Str | ||
| 181 | |||
| 182 | The storage type of the file system. Valid values are C<SSD> and | ||
| 183 | C<HDD>. If set to C<SSD>, the file system uses solid state drive | ||
| 184 | storage. If set to C<HDD>, the file system uses hard disk drive | ||
| 185 | storage. | ||
| 186 | |||
| 187 | |||
| 188 | =head2 SubnetIds => ArrayRef[Str|Undef] | ||
| 189 | |||
| 190 | Specifies the IDs of the subnets that the file system is accessible | ||
| 191 | from. For Windows C<MULTI_AZ_1> file system deployment type, there are | ||
| 192 | two subnet IDs, one for the preferred file server and one for the | ||
| 193 | standby file server. The preferred file server subnet identified in the | ||
| 194 | C<PreferredSubnetID> property. All other file systems have only one | ||
| 195 | subnet ID. | ||
| 196 | |||
| 197 | For Lustre file systems, and Single-AZ Windows file systems, this is | ||
| 198 | the ID of the subnet that contains the endpoint for the file system. | ||
| 199 | For C<MULTI_AZ_1> Windows file systems, the endpoint for the file | ||
| 200 | system is available in the C<PreferredSubnetID>. | ||
| 201 | |||
| 202 | |||
| 203 | =head2 Tags => ArrayRef[L<Paws::FSX::Tag>] | ||
| 204 | |||
| 205 | The tags to associate with the file system. For more information, see | ||
| 206 | Tagging Your Amazon EC2 Resources | ||
| 207 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) | ||
| 208 | in the I<Amazon EC2 User Guide>. | ||
| 209 | |||
| 210 | |||
| 211 | =head2 VpcId => Str | ||
| 212 | |||
| 213 | The ID of the primary VPC for the file system. | ||
| 214 | |||
| 215 | |||
| 216 | =head2 WindowsConfiguration => L<Paws::FSX::WindowsFileSystemConfiguration> | ||
| 217 | |||
| 218 | The configuration for this Microsoft Windows file system. | ||
| 219 | |||
| 220 | |||
| 221 | |||
| 222 | =head1 SEE ALSO | ||
| 223 | |||
| 224 | This class forms part of L<Paws>, describing an object used in L<Paws::FSX> | ||
| 225 | |||
| 226 | =head1 BUGS and CONTRIBUTIONS | ||
| 227 | |||
| 228 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 229 | |||
| 230 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 231 | |||
| 232 | =cut | ||
| 233 |