blib/lib/Paws/Kinesis/StreamDescriptionSummary.pm untested

filter: Statementstmt 0.0% 0 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 14 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Kinesis::StreamDescriptionSummary;
3 use Moose;
4 has ConsumerCount => (is => 'ro', isa => 'Int');
5 has EncryptionType => (is => 'ro', isa => 'Str');
6 has EnhancedMonitoring => (is => 'ro', isa => 'ArrayRef[Paws::Kinesis::EnhancedMetrics]', required => 1);
7 has KeyId => (is => 'ro', isa => 'Str');
8 has OpenShardCount => (is => 'ro', isa => 'Int', required => 1);
9 has RetentionPeriodHours => (is => 'ro', isa => 'Int', required => 1);
10 has StreamARN => (is => 'ro', isa => 'Str', required => 1);
11 has StreamCreationTimestamp => (is => 'ro', isa => 'Str', required => 1);
12 has StreamName => (is => 'ro', isa => 'Str', required => 1);
13 has StreamStatus => (is => 'ro', isa => 'Str', required => 1);
14  
15 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::Kinesis::StreamDescriptionSummary
22  
23 =head1 USAGE
24  
25 This class represents one of two things:
26  
27 =head3 Arguments in a call to a service
28  
29 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
30 Each attribute should be used as a named argument in the calls that expect this type of object.
31  
32 As an example, if Att1 is expected to be a Paws::Kinesis::StreamDescriptionSummary object:
33  
34 $service_obj->Method(Att1 => { ConsumerCount => $value, ..., StreamStatus => $value });
35  
36 =head3 Results returned from an API call
37  
38 Use accessors for each attribute. If Att1 is expected to be an Paws::Kinesis::StreamDescriptionSummary object:
39  
40 $result = $service_obj->Method(...);
41 $result->Att1->ConsumerCount
42  
43 =head1 DESCRIPTION
44  
45 Represents the output for DescribeStreamSummary
46  
47 =head1 ATTRIBUTES
48  
49  
50 =head2 ConsumerCount => Int
51  
52 The number of enhanced fan-out consumers registered with the stream.
53  
54  
55 =head2 EncryptionType => Str
56  
57 The encryption type used. This value is one of the following:
58  
59 =over
60  
61 =item *
62  
63 C<KMS>
64  
65 =item *
66  
67 C<NONE>
68  
69 =back
70  
71  
72  
73 =head2 B<REQUIRED> EnhancedMonitoring => ArrayRef[L<Paws::Kinesis::EnhancedMetrics>]
74  
75 Represents the current enhanced monitoring settings of the stream.
76  
77  
78 =head2 KeyId => Str
79  
80 The GUID for the customer-managed AWS KMS key to use for encryption.
81 This value can be a globally unique identifier, a fully specified ARN
82 to either an alias or a key, or an alias name prefixed by "alias/".You
83 can also use a master key owned by Kinesis Data Streams by specifying
84 the alias C<aws/kinesis>.
85  
86 =over
87  
88 =item *
89  
90 Key ARN example:
91 C<arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012>
92  
93 =item *
94  
95 Alias ARN example: C<
96 arn:aws:kms:us-east-1:123456789012:alias/MyAliasName>
97  
98 =item *
99  
100 Globally unique key ID example: C<12345678-1234-1234-1234-123456789012>
101  
102 =item *
103  
104 Alias name example: C<alias/MyAliasName>
105  
106 =item *
107  
108 Master key owned by Kinesis Data Streams: C<alias/aws/kinesis>
109  
110 =back
111  
112  
113  
114 =head2 B<REQUIRED> OpenShardCount => Int
115  
116 The number of open shards in the stream.
117  
118  
119 =head2 B<REQUIRED> RetentionPeriodHours => Int
120  
121 The current retention period, in hours.
122  
123  
124 =head2 B<REQUIRED> StreamARN => Str
125  
126 The Amazon Resource Name (ARN) for the stream being described.
127  
128  
129 =head2 B<REQUIRED> StreamCreationTimestamp => Str
130  
131 The approximate time that the stream was created.
132  
133  
134 =head2 B<REQUIRED> StreamName => Str
135  
136 The name of the stream being described.
137  
138  
139 =head2 B<REQUIRED> StreamStatus => Str
140  
141 The current status of the stream being described. The stream status is
142 one of the following states:
143  
144 =over
145  
146 =item *
147  
148 C<CREATING> - The stream is being created. Kinesis Data Streams
149 immediately returns and sets C<StreamStatus> to C<CREATING>.
150  
151 =item *
152  
153 C<DELETING> - The stream is being deleted. The specified stream is in
154 the C<DELETING> state until Kinesis Data Streams completes the
155 deletion.
156  
157 =item *
158  
159 C<ACTIVE> - The stream exists and is ready for read and write
160 operations or deletion. You should perform read and write operations
161 only on an C<ACTIVE> stream.
162  
163 =item *
164  
165 C<UPDATING> - Shards in the stream are being merged or split. Read and
166 write operations continue to work while the stream is in the
167 C<UPDATING> state.
168  
169 =back
170  
171  
172  
173  
174 =head1 SEE ALSO
175  
176 This class forms part of L<Paws>, describing an object used in L<Paws::Kinesis>
177  
178 =head1 BUGS and CONTRIBUTIONS
179  
180 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
181  
182 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
183  
184 =cut
185