« blib/lib/Paws/DynamoDB/BackupDetails.pm
↑ Summary
blib/lib/Paws/DynamoDB/BatchExecuteStatement.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DynamoDB::BackupSummary; | ||
| 3 | use Moose; | ||
| 4 | has BackupArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has BackupCreationDateTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has BackupExpiryDateTime => (is => 'ro', isa => 'Str'); | ||
| 7 | has BackupName => (is => 'ro', isa => 'Str'); | ||
| 8 | has BackupSizeBytes => (is => 'ro', isa => 'Int'); | ||
| 9 | has BackupStatus => (is => 'ro', isa => 'Str'); | ||
| 10 | has BackupType => (is => 'ro', isa => 'Str'); | ||
| 11 | has TableArn => (is => 'ro', isa => 'Str'); | ||
| 12 | has TableId => (is => 'ro', isa => 'Str'); | ||
| 13 | has TableName => (is => 'ro', isa => 'Str'); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::DynamoDB::BackupSummary | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::DynamoDB::BackupSummary object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { BackupArn => $value, ..., TableName => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::BackupSummary object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->BackupArn | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Contains details for the backup. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 BackupArn => Str | ||
| 51 | |||
| 52 | ARN associated with the backup. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 BackupCreationDateTime => Str | ||
| 56 | |||
| 57 | Time at which the backup was created. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 BackupExpiryDateTime => Str | ||
| 61 | |||
| 62 | Time at which the automatic on-demand backup created by DynamoDB will | ||
| 63 | expire. This C<SYSTEM> on-demand backup expires automatically 35 days | ||
| 64 | after its creation. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 BackupName => Str | ||
| 68 | |||
| 69 | Name of the specified backup. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 BackupSizeBytes => Int | ||
| 73 | |||
| 74 | Size of the backup in bytes. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 BackupStatus => Str | ||
| 78 | |||
| 79 | Backup can be in one of the following states: CREATING, ACTIVE, | ||
| 80 | DELETED. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 BackupType => Str | ||
| 84 | |||
| 85 | BackupType: | ||
| 86 | |||
| 87 | =over | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | C<USER> - You create and manage these using the on-demand backup | ||
| 92 | feature. | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | C<SYSTEM> - If you delete a table with point-in-time recovery enabled, | ||
| 97 | a C<SYSTEM> backup is automatically created and is retained for 35 days | ||
| 98 | (at no additional cost). System backups allow you to restore the | ||
| 99 | deleted table to the state it was in just before the point of deletion. | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | C<AWS_BACKUP> - On-demand backup created by you from AWS Backup | ||
| 104 | service. | ||
| 105 | |||
| 106 | =back | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 TableArn => Str | ||
| 111 | |||
| 112 | ARN associated with the table. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 TableId => Str | ||
| 116 | |||
| 117 | Unique identifier for the table. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 TableName => Str | ||
| 121 | |||
| 122 | Name of the table. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head1 SEE ALSO | ||
| 127 | |||
| 128 | This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB> | ||
| 129 | |||
| 130 | =head1 BUGS and CONTRIBUTIONS | ||
| 131 | |||
| 132 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 133 | |||
| 134 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 135 | |||
| 136 | =cut | ||
| 137 |