« blib/lib/Paws/DynamoDB/CreateBackupOutput.pm
↑ Summary
blib/lib/Paws/DynamoDB/CreateGlobalTable.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DynamoDB::CreateGlobalSecondaryIndexAction; | ||
| 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::CreateGlobalSecondaryIndexAction | ||
| 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::CreateGlobalSecondaryIndexAction 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::CreateGlobalSecondaryIndexAction object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->IndexName | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Represents a new global secondary index to be added to an existing | ||
| 40 | table. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> IndexName => Str | ||
| 46 | |||
| 47 | The name of the global secondary index to be created. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> KeySchema => ArrayRef[L<Paws::DynamoDB::KeySchemaElement>] | ||
| 51 | |||
| 52 | The key schema for the global secondary index. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> Projection => L<Paws::DynamoDB::Projection> | ||
| 56 | |||
| 57 | Represents attributes that are copied (projected) from the table into | ||
| 58 | an index. These are in addition to the primary key attributes and index | ||
| 59 | key attributes, which are automatically projected. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 ProvisionedThroughput => L<Paws::DynamoDB::ProvisionedThroughput> | ||
| 63 | |||
| 64 | Represents the provisioned throughput settings for the specified global | ||
| 65 | secondary index. | ||
| 66 | |||
| 67 | For current minimum and maximum provisioned throughput values, see | ||
| 68 | Service, Account, and Table Quotas | ||
| 69 | (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) | ||
| 70 | in the I<Amazon DynamoDB Developer Guide>. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head1 SEE ALSO | ||
| 75 | |||
| 76 | This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB> | ||
| 77 | |||
| 78 | =head1 BUGS and CONTRIBUTIONS | ||
| 79 | |||
| 80 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 81 | |||
| 82 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 83 | |||
| 84 | =cut | ||
| 85 |