File Coverage

blib/lib/Paws/DynamoDB/StreamSpecification.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1             package Paws::DynamoDB::StreamSpecification;
2 1     1   549 use Moose;
  1     1   2  
  1         9  
  1         413  
  1         3  
  1         6  
3             has StreamEnabled => (is => 'ro', isa => 'Bool');
4             has StreamViewType => (is => 'ro', isa => 'Str');
5             1;
6              
7             ### main pod documentation begin ###
8              
9             =head1 NAME
10              
11             Paws::DynamoDB::StreamSpecification
12              
13             =head1 USAGE
14              
15             This class represents one of two things:
16              
17             =head3 Arguments in a call to a service
18              
19             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
20             Each attribute should be used as a named argument in the calls that expect this type of object.
21              
22             As an example, if Att1 is expected to be a Paws::DynamoDB::StreamSpecification object:
23              
24             $service_obj->Method(Att1 => { StreamEnabled => $value, ..., StreamViewType => $value });
25              
26             =head3 Results returned from an API call
27              
28             Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::StreamSpecification object:
29              
30             $result = $service_obj->Method(...);
31             $result->Att1->StreamEnabled
32              
33             =head1 DESCRIPTION
34              
35             Represents the DynamoDB Streams configuration for a table in DynamoDB.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 StreamEnabled => Bool
41              
42             Indicates whether DynamoDB Streams is enabled (true) or disabled
43             (false) on the table.
44              
45              
46             =head2 StreamViewType => Str
47              
48             When an item in the table is modified, C<StreamViewType> determines
49             what information is written to the stream for this table. Valid values
50             for C<StreamViewType> are:
51              
52             =over
53              
54             =item *
55              
56             C<KEYS_ONLY> - Only the key attributes of the modified item are written
57             to the stream.
58              
59             =item *
60              
61             C<NEW_IMAGE> - The entire item, as it appears after it was modified, is
62             written to the stream.
63              
64             =item *
65              
66             C<OLD_IMAGE> - The entire item, as it appeared before it was modified,
67             is written to the stream.
68              
69             =item *
70              
71             C<NEW_AND_OLD_IMAGES> - Both the new and the old item images of the
72             item are written to the stream.
73              
74             =back
75              
76              
77              
78              
79             =head1 SEE ALSO
80              
81             This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB>
82              
83             =head1 BUGS and CONTRIBUTIONS
84              
85             The source code is located here: https://github.com/pplu/aws-sdk-perl
86              
87             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
88              
89             =cut
90