« blib/lib/Paws/DynamoDB/GlobalTable.pm
↑ Summary
blib/lib/Paws/DynamoDB/GlobalTableGlobalSecondaryIndexSettingsUpdate.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DynamoDB::GlobalTableDescription; | ||
| 3 | use Moose; | ||
| 4 | has CreationDateTime => (is => 'ro', isa => 'Str'); | ||
| 5 | has GlobalTableArn => (is => 'ro', isa => 'Str'); | ||
| 6 | has GlobalTableName => (is => 'ro', isa => 'Str'); | ||
| 7 | has GlobalTableStatus => (is => 'ro', isa => 'Str'); | ||
| 8 | has ReplicationGroup => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::ReplicaDescription]'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::DynamoDB::GlobalTableDescription | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::DynamoDB::GlobalTableDescription object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { CreationDateTime => $value, ..., ReplicationGroup => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::GlobalTableDescription object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->CreationDateTime | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Contains details about the global table. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 CreationDateTime => Str | ||
| 46 | |||
| 47 | The creation time of the global table. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 GlobalTableArn => Str | ||
| 51 | |||
| 52 | The unique identifier of the global table. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 GlobalTableName => Str | ||
| 56 | |||
| 57 | The global table name. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 GlobalTableStatus => Str | ||
| 61 | |||
| 62 | The current state of the global table: | ||
| 63 | |||
| 64 | =over | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | C<CREATING> - The global table is being created. | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | C<UPDATING> - The global table is being updated. | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<DELETING> - The global table is being deleted. | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | C<ACTIVE> - The global table is ready for use. | ||
| 81 | |||
| 82 | =back | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 ReplicationGroup => ArrayRef[L<Paws::DynamoDB::ReplicaDescription>] | ||
| 87 | |||
| 88 | The Regions where the global table has replicas. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head1 SEE ALSO | ||
| 93 | |||
| 94 | This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB> | ||
| 95 | |||
| 96 | =head1 BUGS and CONTRIBUTIONS | ||
| 97 | |||
| 98 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 99 | |||
| 100 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 101 | |||
| 102 | =cut | ||
| 103 |