| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DynamoDB::ReplicaDescription; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has GlobalSecondaryIndexes => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::ReplicaGlobalSecondaryIndexDescription]'); | |
| 5 | 1 | has KMSMasterKeyId => (is => 'ro', isa => 'Str'); | |
| 6 | 1 | has ProvisionedThroughputOverride => (is => 'ro', isa => 'Paws::DynamoDB::ProvisionedThroughputOverride'); | |
| 7 | 1 | has RegionName => (is => 'ro', isa => 'Str'); | |
| 8 | 1 | has ReplicaInaccessibleDateTime => (is => 'ro', isa => 'Str'); | |
| 9 | 1 | has ReplicaStatus => (is => 'ro', isa => 'Str'); | |
| 10 | 1 | has ReplicaStatusDescription => (is => 'ro', isa => 'Str'); | |
| 11 | 1 | has ReplicaStatusPercentProgress => (is => 'ro', isa => 'Str'); | |
| 12 | |||
| 13 | 1 | 1; | |
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::DynamoDB::ReplicaDescription | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::DynamoDB::ReplicaDescription object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { GlobalSecondaryIndexes => $value, ..., ReplicaStatusPercentProgress => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::ReplicaDescription object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->GlobalSecondaryIndexes | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Contains the details of the replica. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 GlobalSecondaryIndexes => ArrayRef[L<Paws::DynamoDB::ReplicaGlobalSecondaryIndexDescription>] | ||
| 49 | |||
| 50 | Replica-specific global secondary index settings. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 KMSMasterKeyId => Str | ||
| 54 | |||
| 55 | The AWS KMS customer master key (CMK) of the replica that will be used | ||
| 56 | for AWS KMS encryption. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 ProvisionedThroughputOverride => L<Paws::DynamoDB::ProvisionedThroughputOverride> | ||
| 60 | |||
| 61 | Replica-specific provisioned throughput. If not described, uses the | ||
| 62 | source table's provisioned throughput settings. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 RegionName => Str | ||
| 66 | |||
| 67 | The name of the Region. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 ReplicaInaccessibleDateTime => Str | ||
| 71 | |||
| 72 | The time at which the replica was first detected as inaccessible. To | ||
| 73 | determine cause of inaccessibility check the C<ReplicaStatus> property. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 ReplicaStatus => Str | ||
| 77 | |||
| 78 | The current state of the replica: | ||
| 79 | |||
| 80 | =over | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | C<CREATING> - The replica is being created. | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | C<UPDATING> - The replica is being updated. | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | C<DELETING> - The replica is being deleted. | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | C<ACTIVE> - The replica is ready for use. | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | C<REGION_DISABLED> - The replica is inaccessible because the AWS Region | ||
| 101 | has been disabled. | ||
| 102 | |||
| 103 | If the AWS Region remains inaccessible for more than 20 hours, DynamoDB | ||
| 104 | will remove this replica from the replication group. The replica will | ||
| 105 | not be deleted and replication will stop from and to this region. | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | C<INACCESSIBLE_ENCRYPTION_CREDENTIALS > - The AWS KMS key used to | ||
| 110 | encrypt the table is inaccessible. | ||
| 111 | |||
| 112 | If the AWS KMS key remains inaccessible for more than 20 hours, | ||
| 113 | DynamoDB will remove this replica from the replication group. The | ||
| 114 | replica will not be deleted and replication will stop from and to this | ||
| 115 | region. | ||
| 116 | |||
| 117 | =back | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 ReplicaStatusDescription => Str | ||
| 122 | |||
| 123 | Detailed information about the replica status. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 ReplicaStatusPercentProgress => Str | ||
| 127 | |||
| 128 | Specifies the progress of a Create, Update, or Delete action on the | ||
| 129 | replica as a percentage. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head1 SEE ALSO | ||
| 134 | |||
| 135 | This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB> | ||
| 136 | |||
| 137 | =head1 BUGS and CONTRIBUTIONS | ||
| 138 | |||
| 139 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 140 | |||
| 141 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 142 | |||
| 143 | =cut | ||
| 144 | |||