File Coverage

blib/lib/Paws/DynamoDB/GlobalSecondaryIndex.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::DynamoDB::GlobalSecondaryIndex;
2 1     1   537 use Moose;
  1         3  
  1         8  
3             has IndexName => (is => 'ro', isa => 'Str', required => 1);
4             has KeySchema => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::KeySchemaElement]', required => 1);
5             has Projection => (is => 'ro', isa => 'Paws::DynamoDB::Projection', required => 1);
6             has ProvisionedThroughput => (is => 'ro', isa => 'Paws::DynamoDB::ProvisionedThroughput', required => 1);
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::DynamoDB::GlobalSecondaryIndex
14              
15             =head1 USAGE
16              
17             This class represents one of two things:
18              
19             =head3 Arguments in a call to a service
20              
21             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
22             Each attribute should be used as a named argument in the calls that expect this type of object.
23              
24             As an example, if Att1 is expected to be a Paws::DynamoDB::GlobalSecondaryIndex object:
25              
26             $service_obj->Method(Att1 => { IndexName => $value, ..., ProvisionedThroughput => $value });
27              
28             =head3 Results returned from an API call
29              
30             Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::GlobalSecondaryIndex object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->IndexName
34              
35             =head1 DESCRIPTION
36              
37             Represents the properties of a global secondary index.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 B<REQUIRED> IndexName => Str
43              
44             The name of the global secondary index. The name must be unique among
45             all other indexes on this table.
46              
47              
48             =head2 B<REQUIRED> KeySchema => ArrayRef[L<Paws::DynamoDB::KeySchemaElement>]
49              
50             The complete key schema for a global secondary index, which consists of
51             one or more pairs of attribute names and key types:
52              
53             =over
54              
55             =item *
56              
57             C<HASH> - partition key
58              
59             =item *
60              
61             C<RANGE> - sort key
62              
63             =back
64              
65             The partition key of an item is also known as its I<hash attribute>.
66             The term "hash attribute" derives from DynamoDB' usage of an internal
67             hash function to evenly distribute data items across partitions, based
68             on their partition key values.
69              
70             The sort key of an item is also known as its I<range attribute>. The
71             term "range attribute" derives from the way DynamoDB stores items with
72             the same partition key physically close together, in sorted order by
73             the sort key value.
74              
75              
76             =head2 B<REQUIRED> Projection => L<Paws::DynamoDB::Projection>
77              
78             Represents attributes that are copied (projected) from the table into
79             the global secondary index. These are in addition to the primary key
80             attributes and index key attributes, which are automatically projected.
81              
82              
83             =head2 B<REQUIRED> ProvisionedThroughput => L<Paws::DynamoDB::ProvisionedThroughput>
84              
85             Represents the provisioned throughput settings for the specified global
86             secondary index.
87              
88             For current minimum and maximum provisioned throughput values, see
89             Limits in the I<Amazon DynamoDB Developer Guide>.
90              
91              
92              
93             =head1 SEE ALSO
94              
95             This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB>
96              
97             =head1 BUGS and CONTRIBUTIONS
98              
99             The source code is located here: https://github.com/pplu/aws-sdk-perl
100              
101             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
102              
103             =cut
104