| 1 | |||
| 2 | package Paws::EFS::FileSystemDescription; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has AvailabilityZoneId => (is => 'ro', isa => 'Str'); | |
| 5 | 1 | has AvailabilityZoneName => (is => 'ro', isa => 'Str'); | |
| 6 | 1 | has CreationTime => (is => 'ro', isa => 'Str', required => 1); | |
| 7 | 1 | has CreationToken => (is => 'ro', isa => 'Str', required => 1); | |
| 8 | 1 | has Encrypted => (is => 'ro', isa => 'Bool'); | |
| 9 | 1 | has FileSystemArn => (is => 'ro', isa => 'Str'); | |
| 10 | 1 | has FileSystemId => (is => 'ro', isa => 'Str', required => 1); | |
| 11 | 1 | has KmsKeyId => (is => 'ro', isa => 'Str'); | |
| 12 | 1 | has LifeCycleState => (is => 'ro', isa => 'Str', required => 1); | |
| 13 | 1 | has Name => (is => 'ro', isa => 'Str'); | |
| 14 | 1 | has NumberOfMountTargets => (is => 'ro', isa => 'Int', required => 1); | |
| 15 | 1 | has OwnerId => (is => 'ro', isa => 'Str', required => 1); | |
| 16 | 1 | has PerformanceMode => (is => 'ro', isa => 'Str', required => 1); | |
| 17 | 1 | has ProvisionedThroughputInMibps => (is => 'ro', isa => 'Num'); | |
| 18 | 1 | has SizeInBytes => (is => 'ro', isa => 'Paws::EFS::FileSystemSize', required => 1); | |
| 19 | 1 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::EFS::Tag]', required => 1); | |
| 20 | 1 | has ThroughputMode => (is => 'ro', isa => 'Str'); | |
| 21 | |||
| 22 | 1 | has _request_id => (is => 'ro', isa => 'Str'); | |
| 23 | 1 | 1; | |
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::EFS::FileSystemDescription | ||
| 30 | |||
| 31 | =head1 ATTRIBUTES | ||
| 32 | |||
| 33 | |||
| 34 | =head2 AvailabilityZoneId => Str | ||
| 35 | |||
| 36 | The unique and consistent identifier of the Availability Zone in which | ||
| 37 | the file system's One Zone storage classes exist. For example, | ||
| 38 | C<use1-az1> is an Availability Zone ID for the us-east-1 AWS Region, | ||
| 39 | and it has the same location in every AWS account. | ||
| 40 | |||
| 41 | |||
| 42 | =head2 AvailabilityZoneName => Str | ||
| 43 | |||
| 44 | Describes the AWS Availability Zone in which the file system is | ||
| 45 | located, and is valid only for file systems using One Zone storage | ||
| 46 | classes. For more information, see Using EFS storage classes | ||
| 47 | (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the | ||
| 48 | I<Amazon EFS User Guide>. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> CreationTime => Str | ||
| 52 | |||
| 53 | The time that the file system was created, in seconds (since | ||
| 54 | 1970-01-01T00:00:00Z). | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> CreationToken => Str | ||
| 58 | |||
| 59 | The opaque string specified in the request. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 Encrypted => Bool | ||
| 63 | |||
| 64 | A Boolean value that, if true, indicates that the file system is | ||
| 65 | encrypted. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 FileSystemArn => Str | ||
| 69 | |||
| 70 | The Amazon Resource Name (ARN) for the EFS file system, in the format | ||
| 71 | C<arn:aws:elasticfilesystem:I<region>:I<account-id>:file-system/I<file-system-id> | ||
| 72 | >. Example with sample data: | ||
| 73 | C<arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567> | ||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> FileSystemId => Str | ||
| 77 | |||
| 78 | The ID of the file system, assigned by Amazon EFS. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 KmsKeyId => Str | ||
| 82 | |||
| 83 | The ID of an AWS Key Management Service (AWS KMS) customer master key | ||
| 84 | (CMK) that was used to protect the encrypted file system. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> LifeCycleState => Str | ||
| 88 | |||
| 89 | The lifecycle phase of the file system. | ||
| 90 | |||
| 91 | Valid values are: C<"creating">, C<"available">, C<"updating">, C<"deleting">, C<"deleted">, C<"error"> | ||
| 92 | =head2 Name => Str | ||
| 93 | |||
| 94 | You can add tags to a file system, including a C<Name> tag. For more | ||
| 95 | information, see CreateFileSystem. If the file system has a C<Name> | ||
| 96 | tag, Amazon EFS returns the value in this field. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> NumberOfMountTargets => Int | ||
| 100 | |||
| 101 | The current number of mount targets that the file system has. For more | ||
| 102 | information, see CreateMountTarget. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 B<REQUIRED> OwnerId => Str | ||
| 106 | |||
| 107 | The AWS account that created the file system. If the file system was | ||
| 108 | created by an IAM user, the parent account to which the user belongs is | ||
| 109 | the owner. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 B<REQUIRED> PerformanceMode => Str | ||
| 113 | |||
| 114 | The performance mode of the file system. | ||
| 115 | |||
| 116 | Valid values are: C<"generalPurpose">, C<"maxIO"> | ||
| 117 | =head2 ProvisionedThroughputInMibps => Num | ||
| 118 | |||
| 119 | The amount of provisioned throughput, measured in MiB/s, for the file | ||
| 120 | system. Valid for file systems using C<ThroughputMode> set to | ||
| 121 | C<provisioned>. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 B<REQUIRED> SizeInBytes => L<Paws::EFS::FileSystemSize> | ||
| 125 | |||
| 126 | The latest known metered size (in bytes) of data stored in the file | ||
| 127 | system, in its C<Value> field, and the time at which that size was | ||
| 128 | determined in its C<Timestamp> field. The C<Timestamp> value is the | ||
| 129 | integer number of seconds since 1970-01-01T00:00:00Z. The | ||
| 130 | C<SizeInBytes> value doesn't represent the size of a consistent | ||
| 131 | snapshot of the file system, but it is eventually consistent when there | ||
| 132 | are no writes to the file system. That is, C<SizeInBytes> represents | ||
| 133 | actual size only if the file system is not modified for a period longer | ||
| 134 | than a couple of hours. Otherwise, the value is not the exact size that | ||
| 135 | the file system was at any point in time. | ||
| 136 | |||
| 137 | |||
| 138 | =head2 B<REQUIRED> Tags => ArrayRef[L<Paws::EFS::Tag>] | ||
| 139 | |||
| 140 | The tags associated with the file system, presented as an array of | ||
| 141 | C<Tag> objects. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 ThroughputMode => Str | ||
| 145 | |||
| 146 | Displays the file system's throughput mode. For more information, see | ||
| 147 | Throughput modes | ||
| 148 | (https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes) | ||
| 149 | in the I<Amazon EFS User Guide>. | ||
| 150 | |||
| 151 | Valid values are: C<"bursting">, C<"provisioned"> | ||
| 152 | =head2 _request_id => Str | ||
| 153 | |||
| 154 | |||
| 155 | =cut | ||
| 156 | |||