« blib/lib/Paws/FSX/AssociateFileSystemAliasesResponse.pm
↑ Summary
blib/lib/Paws/FSX/BackupFailureDetails.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::FSX::Backup; | ||
| 3 | use Moose; | ||
| 4 | has BackupId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has CreationTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DirectoryInformation => (is => 'ro', isa => 'Paws::FSX::ActiveDirectoryBackupAttributes'); | ||
| 7 | has FailureDetails => (is => 'ro', isa => 'Paws::FSX::BackupFailureDetails'); | ||
| 8 | has FileSystem => (is => 'ro', isa => 'Paws::FSX::FileSystem', required => 1); | ||
| 9 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 10 | has Lifecycle => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has OwnerId => (is => 'ro', isa => 'Str'); | ||
| 12 | has ProgressPercent => (is => 'ro', isa => 'Int'); | ||
| 13 | has ResourceARN => (is => 'ro', isa => 'Str'); | ||
| 14 | has SourceBackupId => (is => 'ro', isa => 'Str'); | ||
| 15 | has SourceBackupRegion => (is => 'ro', isa => 'Str'); | ||
| 16 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::FSX::Tag]'); | ||
| 17 | has Type => (is => 'ro', isa => 'Str', required => 1); | ||
| 18 | |||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::FSX::Backup | ||
| 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::Backup object: | ||
| 37 | |||
| 38 | $service_obj->Method(Att1 => { BackupId => $value, ..., Type => $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::Backup object: | ||
| 43 | |||
| 44 | $result = $service_obj->Method(...); | ||
| 45 | $result->Att1->BackupId | ||
| 46 | |||
| 47 | =head1 DESCRIPTION | ||
| 48 | |||
| 49 | A backup of an Amazon FSx file system. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> BackupId => Str | ||
| 55 | |||
| 56 | The ID of the backup. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> CreationTime => Str | ||
| 60 | |||
| 61 | The time when a particular backup was created. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 DirectoryInformation => L<Paws::FSX::ActiveDirectoryBackupAttributes> | ||
| 65 | |||
| 66 | The configuration of the self-managed Microsoft Active Directory (AD) | ||
| 67 | to which the Windows File Server instance is joined. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 FailureDetails => L<Paws::FSX::BackupFailureDetails> | ||
| 71 | |||
| 72 | Details explaining any failures that occur when creating a backup. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> FileSystem => L<Paws::FSX::FileSystem> | ||
| 76 | |||
| 77 | Metadata of the file system associated with the backup. This metadata | ||
| 78 | is persisted even if the file system is deleted. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 KmsKeyId => Str | ||
| 82 | |||
| 83 | The ID of the AWS Key Management Service (AWS KMS) key used to encrypt | ||
| 84 | the backup of the Amazon FSx file system's data at rest. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> Lifecycle => Str | ||
| 88 | |||
| 89 | The lifecycle status of the backup. | ||
| 90 | |||
| 91 | =over | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | C<AVAILABLE> - The backup is fully available. | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | C<PENDING> - For user-initiated backups on Lustre file systems only; | ||
| 100 | Amazon FSx has not started creating the backup. | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | C<CREATING> - Amazon FSx is creating the backup. | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | C<TRANSFERRING> - For user-initiated backups on Lustre file systems | ||
| 109 | only; Amazon FSx is transferring the backup to S3. | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | C<COPYING> - Amazon FSx is copying the backup. | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | C<DELETED> - Amazon FSx deleted the backup and it is no longer | ||
| 118 | available. | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | C<FAILED> - Amazon FSx could not complete the backup. | ||
| 123 | |||
| 124 | =back | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 OwnerId => Str | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head2 ProgressPercent => Int | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 ResourceARN => Str | ||
| 139 | |||
| 140 | The Amazon Resource Name (ARN) for the backup resource. | ||
| 141 | |||
| 142 | |||
| 143 | =head2 SourceBackupId => Str | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | =head2 SourceBackupRegion => Str | ||
| 149 | |||
| 150 | The source Region of the backup. Specifies the Region from where this | ||
| 151 | backup is copied. | ||
| 152 | |||
| 153 | |||
| 154 | =head2 Tags => ArrayRef[L<Paws::FSX::Tag>] | ||
| 155 | |||
| 156 | Tags associated with a particular file system. | ||
| 157 | |||
| 158 | |||
| 159 | =head2 B<REQUIRED> Type => Str | ||
| 160 | |||
| 161 | The type of the file system backup. | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head1 SEE ALSO | ||
| 166 | |||
| 167 | This class forms part of L<Paws>, describing an object used in L<Paws::FSX> | ||
| 168 | |||
| 169 | =head1 BUGS and CONTRIBUTIONS | ||
| 170 | |||
| 171 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 172 | |||
| 173 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 174 | |||
| 175 | =cut | ||
| 176 |