File Coverage

blib/lib/Paws/OpsWorks/CloudWatchLogsLogStream.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::OpsWorks::CloudWatchLogsLogStream;
2	1	1	566	use Moose;
	1		3
	1		8
3				has BatchCount => (is => 'ro', isa => 'Int');
4				has BatchSize => (is => 'ro', isa => 'Int');
5				has BufferDuration => (is => 'ro', isa => 'Int');
6				has DatetimeFormat => (is => 'ro', isa => 'Str');
7				has Encoding => (is => 'ro', isa => 'Str');
8				has File => (is => 'ro', isa => 'Str');
9				has FileFingerprintLines => (is => 'ro', isa => 'Str');
10				has InitialPosition => (is => 'ro', isa => 'Str');
11				has LogGroupName => (is => 'ro', isa => 'Str');
12				has MultiLineStartPattern => (is => 'ro', isa => 'Str');
13				has TimeZone => (is => 'ro', isa => 'Str');
14				1;
15
16				### main pod documentation begin ###
17
18				=head1 NAME
19
20				Paws::OpsWorks::CloudWatchLogsLogStream
21
22				=head1 USAGE
23
24				This class represents one of two things:
25
26				=head3 Arguments in a call to a service
27
28				Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
29				Each attribute should be used as a named argument in the calls that expect this type of object.
30
31				As an example, if Att1 is expected to be a Paws::OpsWorks::CloudWatchLogsLogStream object:
32
33				$service_obj->Method(Att1 => { BatchCount => $value, ..., TimeZone => $value });
34
35				=head3 Results returned from an API call
36
37				Use accessors for each attribute. If Att1 is expected to be an Paws::OpsWorks::CloudWatchLogsLogStream object:
38
39				$result = $service_obj->Method(...);
40				$result->Att1->BatchCount
41
42				=head1 DESCRIPTION
43
44				Describes the Amazon CloudWatch logs configuration for a layer. For
45				detailed information about members of this data type, see the
46				CloudWatch Logs Agent Reference.
47
48				=head1 ATTRIBUTES
49
50
51				=head2 BatchCount => Int
52
53				Specifies the max number of log events in a batch, up to 10000. The
54				default value is 1000.
55
56
57				=head2 BatchSize => Int
58
59				Specifies the maximum size of log events in a batch, in bytes, up to
60				1048576 bytes. The default value is 32768 bytes. This size is
61				calculated as the sum of all event messages in UTF-8, plus 26 bytes for
62				each log event.
63
64
65				=head2 BufferDuration => Int
66
67				Specifies the time duration for the batching of log events. The minimum
68				value is 5000ms and default value is 5000ms.
69
70
71				=head2 DatetimeFormat => Str
72
73				Specifies how the time stamp is extracted from logs. For more
74				information, see the CloudWatch Logs Agent Reference.
75
76
77				=head2 Encoding => Str
78
79				Specifies the encoding of the log file so that the file can be read
80				correctly. The default is C<utf_8>. Encodings supported by Python
81				C<codecs.decode()> can be used here.
82
83
84				=head2 File => Str
85
86				Specifies log files that you want to push to CloudWatch Logs.
87
88				C<File> can point to a specific file or multiple files (by using wild
89				card characters such as C</var/log/system.log*>). Only the latest file
90				is pushed to CloudWatch Logs, based on file modification time. We
91				recommend that you use wild card characters to specify a series of
92				files of the same type, such as C<access_log.2014-06-01-01>,
93				C<access_log.2014-06-01-02>, and so on by using a pattern like
94				C<access_log.*>. Don't use a wildcard to match multiple file types,
95				such as C<access_log_80> and C<access_log_443>. To specify multiple,
96				different file types, add another log stream entry to the configuration
97				file, so that each log file type is stored in a different log group.
98
99				Zipped files are not supported.
100
101
102				=head2 FileFingerprintLines => Str
103
104				Specifies the range of lines for identifying a file. The valid values
105				are one number, or two dash-delimited numbers, such as '1', '2-5'. The
106				default value is '1', meaning the first line is used to calculate the
107				fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless
108				all specified lines are available.
109
110
111				=head2 InitialPosition => Str
112
113				Specifies where to start to read data (start_of_file or end_of_file).
114				The default is start_of_file. This setting is only used if there is no
115				state persisted for that log stream.
116
117
118				=head2 LogGroupName => Str
119
120				Specifies the destination log group. A log group is created
121				automatically if it doesn't already exist. Log group names can be
122				between 1 and 512 characters long. Allowed characters include a-z, A-Z,
123				0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.'
124				(period).
125
126
127				=head2 MultiLineStartPattern => Str
128
129				Specifies the pattern for identifying the start of a log message.
130
131
132				=head2 TimeZone => Str
133
134				Specifies the time zone of log event time stamps.
135
136
137
138				=head1 SEE ALSO
139
140				This class forms part of L<Paws>, describing an object used in L<Paws::OpsWorks>
141
142				=head1 BUGS and CONTRIBUTIONS
143
144				The source code is located here: https://github.com/pplu/aws-sdk-perl
145
146				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
147
148				=cut
149