« blib/lib/Paws/DynamoDB/ReplicaGlobalSecondaryIndexSettingsUpdate.pm
↑ Summary
blib/lib/Paws/DynamoDB/ReplicaSettingsUpdate.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DynamoDB::ReplicaSettingsDescription; | ||
| 3 | use Moose; | ||
| 4 | has RegionName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ReplicaBillingModeSummary => (is => 'ro', isa => 'Paws::DynamoDB::BillingModeSummary'); | ||
| 6 | has ReplicaGlobalSecondaryIndexSettings => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::ReplicaGlobalSecondaryIndexSettingsDescription]'); | ||
| 7 | has ReplicaProvisionedReadCapacityAutoScalingSettings => (is => 'ro', isa => 'Paws::DynamoDB::AutoScalingSettingsDescription'); | ||
| 8 | has ReplicaProvisionedReadCapacityUnits => (is => 'ro', isa => 'Int'); | ||
| 9 | has ReplicaProvisionedWriteCapacityAutoScalingSettings => (is => 'ro', isa => 'Paws::DynamoDB::AutoScalingSettingsDescription'); | ||
| 10 | has ReplicaProvisionedWriteCapacityUnits => (is => 'ro', isa => 'Int'); | ||
| 11 | has ReplicaStatus => (is => 'ro', isa => 'Str'); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::DynamoDB::ReplicaSettingsDescription | ||
| 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::ReplicaSettingsDescription object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { RegionName => $value, ..., ReplicaStatus => $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::ReplicaSettingsDescription object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->RegionName | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Represents the properties of a replica. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> RegionName => Str | ||
| 49 | |||
| 50 | The Region name of the replica. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 ReplicaBillingModeSummary => L<Paws::DynamoDB::BillingModeSummary> | ||
| 54 | |||
| 55 | The read/write capacity mode of the replica. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 ReplicaGlobalSecondaryIndexSettings => ArrayRef[L<Paws::DynamoDB::ReplicaGlobalSecondaryIndexSettingsDescription>] | ||
| 59 | |||
| 60 | Replica global secondary index settings for the global table. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 ReplicaProvisionedReadCapacityAutoScalingSettings => L<Paws::DynamoDB::AutoScalingSettingsDescription> | ||
| 64 | |||
| 65 | Auto scaling settings for a global table replica's read capacity units. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 ReplicaProvisionedReadCapacityUnits => Int | ||
| 69 | |||
| 70 | The maximum number of strongly consistent reads consumed per second | ||
| 71 | before DynamoDB returns a C<ThrottlingException>. For more information, | ||
| 72 | see Specifying Read and Write Requirements | ||
| 73 | (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) | ||
| 74 | in the I<Amazon DynamoDB Developer Guide>. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 ReplicaProvisionedWriteCapacityAutoScalingSettings => L<Paws::DynamoDB::AutoScalingSettingsDescription> | ||
| 78 | |||
| 79 | Auto scaling settings for a global table replica's write capacity | ||
| 80 | units. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 ReplicaProvisionedWriteCapacityUnits => Int | ||
| 84 | |||
| 85 | The maximum number of writes consumed per second before DynamoDB | ||
| 86 | returns a C<ThrottlingException>. For more information, see Specifying | ||
| 87 | Read and Write Requirements | ||
| 88 | (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) | ||
| 89 | in the I<Amazon DynamoDB Developer Guide>. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 ReplicaStatus => Str | ||
| 93 | |||
| 94 | The current state of the Region: | ||
| 95 | |||
| 96 | =over | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | C<CREATING> - The Region is being created. | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | C<UPDATING> - The Region is being updated. | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | C<DELETING> - The Region is being deleted. | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | C<ACTIVE> - The Region is ready for use. | ||
| 113 | |||
| 114 | =back | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head1 SEE ALSO | ||
| 120 | |||
| 121 | This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB> | ||
| 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 |