| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudHSMv2::Backup; | ||
| 3 | use Moose; | ||
| 4 | has BackupId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has BackupState => (is => 'ro', isa => 'Str'); | ||
| 6 | has ClusterId => (is => 'ro', isa => 'Str'); | ||
| 7 | has CopyTimestamp => (is => 'ro', isa => 'Str'); | ||
| 8 | has CreateTimestamp => (is => 'ro', isa => 'Str'); | ||
| 9 | has DeleteTimestamp => (is => 'ro', isa => 'Str'); | ||
| 10 | has NeverExpires => (is => 'ro', isa => 'Bool'); | ||
| 11 | has SourceBackup => (is => 'ro', isa => 'Str'); | ||
| 12 | has SourceCluster => (is => 'ro', isa => 'Str'); | ||
| 13 | has SourceRegion => (is => 'ro', isa => 'Str'); | ||
| 14 | has TagList => (is => 'ro', isa => 'ArrayRef[Paws::CloudHSMv2::Tag]'); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::CloudHSMv2::Backup | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::CloudHSMv2::Backup object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { BackupId => $value, ..., TagList => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudHSMv2::Backup object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->BackupId | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | Contains information about a backup of an AWS CloudHSM cluster. All | ||
| 47 | backup objects contain the C<BackupId>, C<BackupState>, C<ClusterId>, | ||
| 48 | and C<CreateTimestamp> parameters. Backups that were copied into a | ||
| 49 | destination region additionally contain the C<CopyTimestamp>, | ||
| 50 | C<SourceBackup>, C<SourceCluster>, and C<SourceRegion> parameters. A | ||
| 51 | backup that is pending deletion will include the C<DeleteTimestamp> | ||
| 52 | parameter. | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> BackupId => Str | ||
| 58 | |||
| 59 | The identifier (ID) of the backup. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 BackupState => Str | ||
| 63 | |||
| 64 | The state of the backup. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 ClusterId => Str | ||
| 68 | |||
| 69 | The identifier (ID) of the cluster that was backed up. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 CopyTimestamp => Str | ||
| 73 | |||
| 74 | The date and time when the backup was copied from a source backup. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 CreateTimestamp => Str | ||
| 78 | |||
| 79 | The date and time when the backup was created. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 DeleteTimestamp => Str | ||
| 83 | |||
| 84 | The date and time when the backup will be permanently deleted. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 NeverExpires => Bool | ||
| 88 | |||
| 89 | Specifies whether the service should exempt a backup from the retention | ||
| 90 | policy for the cluster. C<True> exempts a backup from the retention | ||
| 91 | policy. C<False> means the service applies the backup retention policy | ||
| 92 | defined at the cluster. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 SourceBackup => Str | ||
| 96 | |||
| 97 | The identifier (ID) of the source backup from which the new backup was | ||
| 98 | copied. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 SourceCluster => Str | ||
| 102 | |||
| 103 | The identifier (ID) of the cluster containing the source backup from | ||
| 104 | which the new backup was copied. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 SourceRegion => Str | ||
| 108 | |||
| 109 | The AWS Region that contains the source backup from which the new | ||
| 110 | backup was copied. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 TagList => ArrayRef[L<Paws::CloudHSMv2::Tag>] | ||
| 114 | |||
| 115 | The list of tags for the backup. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head1 SEE ALSO | ||
| 120 | |||
| 121 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudHSMv2> | ||
| 122 | |||
| 123 | =head1 BUGS and CONTRIBUTIONS | ||
| 124 | |||
| 125 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 126 | |||
| 127 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 128 | |||
| 129 | =cut | ||
| 130 |