blib/lib/Paws/DynamoDB/GlobalSecondaryIndex.pm untested

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