« blib/lib/Paws/StorageGateway/NotifyWhenUploadedOutput.pm
↑ Summary
blib/lib/Paws/StorageGateway/RefreshCache.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::StorageGateway::PoolInfo; | ||
| 3 | use Moose; | ||
| 4 | has PoolARN => (is => 'ro', isa => 'Str'); | ||
| 5 | has PoolName => (is => 'ro', isa => 'Str'); | ||
| 6 | has PoolStatus => (is => 'ro', isa => 'Str'); | ||
| 7 | has RetentionLockTimeInDays => (is => 'ro', isa => 'Int'); | ||
| 8 | has RetentionLockType => (is => 'ro', isa => 'Str'); | ||
| 9 | has StorageClass => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::StorageGateway::PoolInfo | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::StorageGateway::PoolInfo object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { PoolARN => $value, ..., StorageClass => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::StorageGateway::PoolInfo object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->PoolARN | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Describes a custom tape pool. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 PoolARN => Str | ||
| 47 | |||
| 48 | The Amazon Resource Name (ARN) of the custom tape pool. Use the | ||
| 49 | ListTapePools operation to return a list of custom tape pools for your | ||
| 50 | account and AWS Region. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 PoolName => Str | ||
| 54 | |||
| 55 | The name of the custom tape pool. C<PoolName> can use all ASCII | ||
| 56 | characters, except '/' and '\'. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 PoolStatus => Str | ||
| 60 | |||
| 61 | Status of the custom tape pool. Pool can be C<ACTIVE> or C<DELETED>. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 RetentionLockTimeInDays => Int | ||
| 65 | |||
| 66 | Tape retention lock time is set in days. Tape retention lock can be | ||
| 67 | enabled for up to 100 years (36,500 days). | ||
| 68 | |||
| 69 | |||
| 70 | =head2 RetentionLockType => Str | ||
| 71 | |||
| 72 | Tape retention lock type, which can be configured in two modes. When | ||
| 73 | configured in governance mode, AWS accounts with specific IAM | ||
| 74 | permissions are authorized to remove the tape retention lock from | ||
| 75 | archived virtual tapes. When configured in compliance mode, the tape | ||
| 76 | retention lock cannot be removed by any user, including the root AWS | ||
| 77 | account. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 StorageClass => Str | ||
| 81 | |||
| 82 | The storage class that is associated with the custom pool. When you use | ||
| 83 | your backup application to eject the tape, the tape is archived | ||
| 84 | directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) | ||
| 85 | that corresponds to the pool. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head1 SEE ALSO | ||
| 90 | |||
| 91 | This class forms part of L<Paws>, describing an object used in L<Paws::StorageGateway> | ||
| 92 | |||
| 93 | =head1 BUGS and CONTRIBUTIONS | ||
| 94 | |||
| 95 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 96 | |||
| 97 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 98 | |||
| 99 | =cut | ||
| 100 |