« blib/lib/Paws/DynamoDB/SecondaryIndexesCapacityMap.pm
↑ Summary
blib/lib/Paws/DynamoDB/TableDescription.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DynamoDB::StreamSpecification; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has StreamEnabled => (is => 'ro', isa => 'Bool', required => 1); | |
| 5 | 1 | has StreamViewType => (is => 'ro', isa => 'Str'); | |
| 6 | |||
| 7 | 1 | 1; | |
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::DynamoDB::StreamSpecification | ||
| 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::StreamSpecification object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { StreamEnabled => $value, ..., StreamViewType => $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::StreamSpecification object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->StreamEnabled | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Represents the DynamoDB Streams configuration for a table in DynamoDB. | ||
| 38 | |||
| 39 | =head1 ATTRIBUTES | ||
| 40 | |||
| 41 | |||
| 42 | =head2 B<REQUIRED> StreamEnabled => Bool | ||
| 43 | |||
| 44 | Indicates whether DynamoDB Streams is enabled (true) or disabled | ||
| 45 | (false) on the table. | ||
| 46 | |||
| 47 | |||
| 48 | =head2 StreamViewType => Str | ||
| 49 | |||
| 50 | When an item in the table is modified, C<StreamViewType> determines | ||
| 51 | what information is written to the stream for this table. Valid values | ||
| 52 | for C<StreamViewType> are: | ||
| 53 | |||
| 54 | =over | ||
| 55 | |||
| 56 | =item * | ||
| 57 | |||
| 58 | C<KEYS_ONLY> - Only the key attributes of the modified item are written | ||
| 59 | to the stream. | ||
| 60 | |||
| 61 | =item * | ||
| 62 | |||
| 63 | C<NEW_IMAGE> - The entire item, as it appears after it was modified, is | ||
| 64 | written to the stream. | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | C<OLD_IMAGE> - The entire item, as it appeared before it was modified, | ||
| 69 | is written to the stream. | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | C<NEW_AND_OLD_IMAGES> - Both the new and the old item images of the | ||
| 74 | item are written to the stream. | ||
| 75 | |||
| 76 | =back | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 | |||