File Coverage

blib/lib/Paws/Kinesis/StreamDescription.pm

Criterion	Covered	Total	%
statement	3	3	100.0
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	4	4	100.0

line	stmt	sub	time	code
1				package Paws::Kinesis::StreamDescription;
2	1	1	477	use Moose;
	1		4
	1		7
3				has EncryptionType => (is => 'ro', isa => 'Str');
4				has EnhancedMonitoring => (is => 'ro', isa => 'ArrayRef[Paws::Kinesis::EnhancedMetrics]', required => 1);
5				has HasMoreShards => (is => 'ro', isa => 'Bool', required => 1);
6				has KeyId => (is => 'ro', isa => 'Str');
7				has RetentionPeriodHours => (is => 'ro', isa => 'Int', required => 1);
8				has Shards => (is => 'ro', isa => 'ArrayRef[Paws::Kinesis::Shard]', required => 1);
9				has StreamARN => (is => 'ro', isa => 'Str', required => 1);
10				has StreamCreationTimestamp => (is => 'ro', isa => 'Str', required => 1);
11				has StreamName => (is => 'ro', isa => 'Str', required => 1);
12				has StreamStatus => (is => 'ro', isa => 'Str', required => 1);
13				1;
14
15				### main pod documentation begin ###
16
17				=head1 NAME
18
19				Paws::Kinesis::StreamDescription
20
21				=head1 USAGE
22
23				This class represents one of two things:
24
25				=head3 Arguments in a call to a service
26
27				Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
28				Each attribute should be used as a named argument in the calls that expect this type of object.
29
30				As an example, if Att1 is expected to be a Paws::Kinesis::StreamDescription object:
31
32				$service_obj->Method(Att1 => { EncryptionType => $value, ..., StreamStatus => $value });
33
34				=head3 Results returned from an API call
35
36				Use accessors for each attribute. If Att1 is expected to be an Paws::Kinesis::StreamDescription object:
37
38				$result = $service_obj->Method(...);
39				$result->Att1->EncryptionType
40
41				=head1 DESCRIPTION
42
43				Represents the output for DescribeStream.
44
45				=head1 ATTRIBUTES
46
47
48				=head2 EncryptionType => Str
49
50				The server-side encryption type used on the stream. This parameter can
51				be one of the following values:
52
53				=over
54
55				=item *
56
57				C<NONE>: Do not encrypt the records in the stream.
58
59				=item *
60
61				C<KMS>: Use server-side encryption on the records in the stream using a
62				customer-managed KMS key.
63
64				=back
65
66
67
68				=head2 B<REQUIRED> EnhancedMonitoring => ArrayRef[L<Paws::Kinesis::EnhancedMetrics>]
69
70				Represents the current enhanced monitoring settings of the stream.
71
72
73				=head2 B<REQUIRED> HasMoreShards => Bool
74
75				If set to C<true>, more shards in the stream are available to describe.
76
77
78				=head2 KeyId => Str
79
80				The GUID for the customer-managed KMS key used for encryption on the
81				stream.
82
83
84				=head2 B<REQUIRED> RetentionPeriodHours => Int
85
86				The current retention period, in hours.
87
88
89				=head2 B<REQUIRED> Shards => ArrayRef[L<Paws::Kinesis::Shard>]
90
91				The shards that comprise the stream.
92
93
94				=head2 B<REQUIRED> StreamARN => Str
95
96				The Amazon Resource Name (ARN) for the stream being described.
97
98
99				=head2 B<REQUIRED> StreamCreationTimestamp => Str
100
101				The approximate time that the stream was created.
102
103
104				=head2 B<REQUIRED> StreamName => Str
105
106				The name of the stream being described.
107
108
109				=head2 B<REQUIRED> StreamStatus => Str
110
111				The current status of the stream being described. The stream status is
112				one of the following states:
113
114				=over
115
116				=item *
117
118				C<CREATING> - The stream is being created. Amazon Kinesis immediately
119				returns and sets C<StreamStatus> to C<CREATING>.
120
121				=item *
122
123				C<DELETING> - The stream is being deleted. The specified stream is in
124				the C<DELETING> state until Amazon Kinesis completes the deletion.
125
126				=item *
127
128				C<ACTIVE> - The stream exists and is ready for read and write
129				operations or deletion. You should perform read and write operations
130				only on an C<ACTIVE> stream.
131
132				=item *
133
134				C<UPDATING> - Shards in the stream are being merged or split. Read and
135				write operations continue to work while the stream is in the
136				C<UPDATING> state.
137
138				=back
139
140
141
142
143				=head1 SEE ALSO
144
145				This class forms part of L<Paws>, describing an object used in L<Paws::Kinesis>
146
147				=head1 BUGS and CONTRIBUTIONS
148
149				The source code is located here: https://github.com/pplu/aws-sdk-perl
150
151				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
152
153				=cut
154