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