AWS SDK for C++  1.8.72
AWS SDK for C++
Public Member Functions | List of all members
Aws::OpsWorks::Model::CloudWatchLogsLogStream Class Reference

#include <CloudWatchLogsLogStream.h>

Public Member Functions

 CloudWatchLogsLogStream ()
 
 CloudWatchLogsLogStream (Aws::Utils::Json::JsonView jsonValue)
 
CloudWatchLogsLogStreamoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetLogGroupName () const
 
bool LogGroupNameHasBeenSet () const
 
void SetLogGroupName (const Aws::String &value)
 
void SetLogGroupName (Aws::String &&value)
 
void SetLogGroupName (const char *value)
 
CloudWatchLogsLogStreamWithLogGroupName (const Aws::String &value)
 
CloudWatchLogsLogStreamWithLogGroupName (Aws::String &&value)
 
CloudWatchLogsLogStreamWithLogGroupName (const char *value)
 
const Aws::StringGetDatetimeFormat () const
 
bool DatetimeFormatHasBeenSet () const
 
void SetDatetimeFormat (const Aws::String &value)
 
void SetDatetimeFormat (Aws::String &&value)
 
void SetDatetimeFormat (const char *value)
 
CloudWatchLogsLogStreamWithDatetimeFormat (const Aws::String &value)
 
CloudWatchLogsLogStreamWithDatetimeFormat (Aws::String &&value)
 
CloudWatchLogsLogStreamWithDatetimeFormat (const char *value)
 
const CloudWatchLogsTimeZoneGetTimeZone () const
 
bool TimeZoneHasBeenSet () const
 
void SetTimeZone (const CloudWatchLogsTimeZone &value)
 
void SetTimeZone (CloudWatchLogsTimeZone &&value)
 
CloudWatchLogsLogStreamWithTimeZone (const CloudWatchLogsTimeZone &value)
 
CloudWatchLogsLogStreamWithTimeZone (CloudWatchLogsTimeZone &&value)
 
const Aws::StringGetFile () const
 
bool FileHasBeenSet () const
 
void SetFile (const Aws::String &value)
 
void SetFile (Aws::String &&value)
 
void SetFile (const char *value)
 
CloudWatchLogsLogStreamWithFile (const Aws::String &value)
 
CloudWatchLogsLogStreamWithFile (Aws::String &&value)
 
CloudWatchLogsLogStreamWithFile (const char *value)
 
const Aws::StringGetFileFingerprintLines () const
 
bool FileFingerprintLinesHasBeenSet () const
 
void SetFileFingerprintLines (const Aws::String &value)
 
void SetFileFingerprintLines (Aws::String &&value)
 
void SetFileFingerprintLines (const char *value)
 
CloudWatchLogsLogStreamWithFileFingerprintLines (const Aws::String &value)
 
CloudWatchLogsLogStreamWithFileFingerprintLines (Aws::String &&value)
 
CloudWatchLogsLogStreamWithFileFingerprintLines (const char *value)
 
const Aws::StringGetMultiLineStartPattern () const
 
bool MultiLineStartPatternHasBeenSet () const
 
void SetMultiLineStartPattern (const Aws::String &value)
 
void SetMultiLineStartPattern (Aws::String &&value)
 
void SetMultiLineStartPattern (const char *value)
 
CloudWatchLogsLogStreamWithMultiLineStartPattern (const Aws::String &value)
 
CloudWatchLogsLogStreamWithMultiLineStartPattern (Aws::String &&value)
 
CloudWatchLogsLogStreamWithMultiLineStartPattern (const char *value)
 
const CloudWatchLogsInitialPositionGetInitialPosition () const
 
bool InitialPositionHasBeenSet () const
 
void SetInitialPosition (const CloudWatchLogsInitialPosition &value)
 
void SetInitialPosition (CloudWatchLogsInitialPosition &&value)
 
CloudWatchLogsLogStreamWithInitialPosition (const CloudWatchLogsInitialPosition &value)
 
CloudWatchLogsLogStreamWithInitialPosition (CloudWatchLogsInitialPosition &&value)
 
const CloudWatchLogsEncodingGetEncoding () const
 
bool EncodingHasBeenSet () const
 
void SetEncoding (const CloudWatchLogsEncoding &value)
 
void SetEncoding (CloudWatchLogsEncoding &&value)
 
CloudWatchLogsLogStreamWithEncoding (const CloudWatchLogsEncoding &value)
 
CloudWatchLogsLogStreamWithEncoding (CloudWatchLogsEncoding &&value)
 
int GetBufferDuration () const
 
bool BufferDurationHasBeenSet () const
 
void SetBufferDuration (int value)
 
CloudWatchLogsLogStreamWithBufferDuration (int value)
 
int GetBatchCount () const
 
bool BatchCountHasBeenSet () const
 
void SetBatchCount (int value)
 
CloudWatchLogsLogStreamWithBatchCount (int value)
 
int GetBatchSize () const
 
bool BatchSizeHasBeenSet () const
 
void SetBatchSize (int value)
 
CloudWatchLogsLogStreamWithBatchSize (int value)
 

Detailed Description

Describes the Amazon CloudWatch logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference.

See Also:

AWS API Reference

Definition at line 37 of file CloudWatchLogsLogStream.h.

Constructor & Destructor Documentation

◆ CloudWatchLogsLogStream() [1/2]

Aws::OpsWorks::Model::CloudWatchLogsLogStream::CloudWatchLogsLogStream ( )

◆ CloudWatchLogsLogStream() [2/2]

Aws::OpsWorks::Model::CloudWatchLogsLogStream::CloudWatchLogsLogStream ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ BatchCountHasBeenSet()

bool Aws::OpsWorks::Model::CloudWatchLogsLogStream::BatchCountHasBeenSet ( ) const
inline

Specifies the max number of log events in a batch, up to 10000. The default value is 1000.

Definition at line 563 of file CloudWatchLogsLogStream.h.

◆ BatchSizeHasBeenSet()

bool Aws::OpsWorks::Model::CloudWatchLogsLogStream::BatchSizeHasBeenSet ( ) const
inline

Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

Definition at line 590 of file CloudWatchLogsLogStream.h.

◆ BufferDurationHasBeenSet()

bool Aws::OpsWorks::Model::CloudWatchLogsLogStream::BufferDurationHasBeenSet ( ) const
inline

Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.

Definition at line 538 of file CloudWatchLogsLogStream.h.

◆ DatetimeFormatHasBeenSet()

bool Aws::OpsWorks::Model::CloudWatchLogsLogStream::DatetimeFormatHasBeenSet ( ) const
inline

Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.

Definition at line 125 of file CloudWatchLogsLogStream.h.

◆ EncodingHasBeenSet()

bool Aws::OpsWorks::Model::CloudWatchLogsLogStream::EncodingHasBeenSet ( ) const
inline

Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

Definition at line 497 of file CloudWatchLogsLogStream.h.

◆ FileFingerprintLinesHasBeenSet()

bool Aws::OpsWorks::Model::CloudWatchLogsLogStream::FileFingerprintLinesHasBeenSet ( ) const
inline

Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.

Definition at line 344 of file CloudWatchLogsLogStream.h.

◆ FileHasBeenSet()

bool Aws::OpsWorks::Model::CloudWatchLogsLogStream::FileHasBeenSet ( ) const
inline

Specifies log files that you want to push to CloudWatch Logs.

File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on by using a pattern like access_log.*. Don't use a wildcard to match multiple file types, such as access_log_80 and access_log_443. To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group.

Zipped files are not supported.

Definition at line 235 of file CloudWatchLogsLogStream.h.

◆ GetBatchCount()

int Aws::OpsWorks::Model::CloudWatchLogsLogStream::GetBatchCount ( ) const
inline

Specifies the max number of log events in a batch, up to 10000. The default value is 1000.

Definition at line 557 of file CloudWatchLogsLogStream.h.

◆ GetBatchSize()

int Aws::OpsWorks::Model::CloudWatchLogsLogStream::GetBatchSize ( ) const
inline

Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

Definition at line 583 of file CloudWatchLogsLogStream.h.

◆ GetBufferDuration()

int Aws::OpsWorks::Model::CloudWatchLogsLogStream::GetBufferDuration ( ) const
inline

Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.

Definition at line 532 of file CloudWatchLogsLogStream.h.

◆ GetDatetimeFormat()

const Aws::String& Aws::OpsWorks::Model::CloudWatchLogsLogStream::GetDatetimeFormat ( ) const
inline

Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.

Definition at line 117 of file CloudWatchLogsLogStream.h.

◆ GetEncoding()

const CloudWatchLogsEncoding& Aws::OpsWorks::Model::CloudWatchLogsLogStream::GetEncoding ( ) const
inline

Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

Definition at line 490 of file CloudWatchLogsLogStream.h.

◆ GetFile()

const Aws::String& Aws::OpsWorks::Model::CloudWatchLogsLogStream::GetFile ( ) const
inline

Specifies log files that you want to push to CloudWatch Logs.

File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on by using a pattern like access_log.*. Don't use a wildcard to match multiple file types, such as access_log_80 and access_log_443. To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group.

Zipped files are not supported.

Definition at line 220 of file CloudWatchLogsLogStream.h.

◆ GetFileFingerprintLines()

const Aws::String& Aws::OpsWorks::Model::CloudWatchLogsLogStream::GetFileFingerprintLines ( ) const
inline

Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.

Definition at line 335 of file CloudWatchLogsLogStream.h.

◆ GetInitialPosition()

const CloudWatchLogsInitialPosition& Aws::OpsWorks::Model::CloudWatchLogsLogStream::GetInitialPosition ( ) const
inline

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.

Definition at line 447 of file CloudWatchLogsLogStream.h.

◆ GetLogGroupName()

const Aws::String& Aws::OpsWorks::Model::CloudWatchLogsLogStream::GetLogGroupName ( ) const
inline

Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

Definition at line 52 of file CloudWatchLogsLogStream.h.

◆ GetMultiLineStartPattern()

const Aws::String& Aws::OpsWorks::Model::CloudWatchLogsLogStream::GetMultiLineStartPattern ( ) const
inline

Specifies the pattern for identifying the start of a log message.

Definition at line 404 of file CloudWatchLogsLogStream.h.

◆ GetTimeZone()

const CloudWatchLogsTimeZone& Aws::OpsWorks::Model::CloudWatchLogsLogStream::GetTimeZone ( ) const
inline

Specifies the time zone of log event time stamps.

Definition at line 179 of file CloudWatchLogsLogStream.h.

◆ InitialPositionHasBeenSet()

bool Aws::OpsWorks::Model::CloudWatchLogsLogStream::InitialPositionHasBeenSet ( ) const
inline

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.

Definition at line 454 of file CloudWatchLogsLogStream.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::OpsWorks::Model::CloudWatchLogsLogStream::Jsonize ( ) const

◆ LogGroupNameHasBeenSet()

bool Aws::OpsWorks::Model::CloudWatchLogsLogStream::LogGroupNameHasBeenSet ( ) const
inline

Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

Definition at line 60 of file CloudWatchLogsLogStream.h.

◆ MultiLineStartPatternHasBeenSet()

bool Aws::OpsWorks::Model::CloudWatchLogsLogStream::MultiLineStartPatternHasBeenSet ( ) const
inline

Specifies the pattern for identifying the start of a log message.

Definition at line 409 of file CloudWatchLogsLogStream.h.

◆ operator=()

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetBatchCount()

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetBatchCount ( int  value)
inline

Specifies the max number of log events in a batch, up to 10000. The default value is 1000.

Definition at line 569 of file CloudWatchLogsLogStream.h.

◆ SetBatchSize()

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetBatchSize ( int  value)
inline

Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

Definition at line 597 of file CloudWatchLogsLogStream.h.

◆ SetBufferDuration()

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetBufferDuration ( int  value)
inline

Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.

Definition at line 544 of file CloudWatchLogsLogStream.h.

◆ SetDatetimeFormat() [1/3]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetDatetimeFormat ( const Aws::String value)
inline

Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.

Definition at line 133 of file CloudWatchLogsLogStream.h.

◆ SetDatetimeFormat() [2/3]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetDatetimeFormat ( Aws::String &&  value)
inline

Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.

Definition at line 141 of file CloudWatchLogsLogStream.h.

◆ SetDatetimeFormat() [3/3]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetDatetimeFormat ( const char *  value)
inline

Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.

Definition at line 149 of file CloudWatchLogsLogStream.h.

◆ SetEncoding() [1/2]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetEncoding ( const CloudWatchLogsEncoding value)
inline

Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

Definition at line 504 of file CloudWatchLogsLogStream.h.

◆ SetEncoding() [2/2]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetEncoding ( CloudWatchLogsEncoding &&  value)
inline

Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

Definition at line 511 of file CloudWatchLogsLogStream.h.

◆ SetFile() [1/3]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetFile ( const Aws::String value)
inline

Specifies log files that you want to push to CloudWatch Logs.

File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on by using a pattern like access_log.*. Don't use a wildcard to match multiple file types, such as access_log_80 and access_log_443. To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group.

Zipped files are not supported.

Definition at line 250 of file CloudWatchLogsLogStream.h.

◆ SetFile() [2/3]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetFile ( Aws::String &&  value)
inline

Specifies log files that you want to push to CloudWatch Logs.

File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on by using a pattern like access_log.*. Don't use a wildcard to match multiple file types, such as access_log_80 and access_log_443. To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group.

Zipped files are not supported.

Definition at line 265 of file CloudWatchLogsLogStream.h.

◆ SetFile() [3/3]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetFile ( const char *  value)
inline

Specifies log files that you want to push to CloudWatch Logs.

File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on by using a pattern like access_log.*. Don't use a wildcard to match multiple file types, such as access_log_80 and access_log_443. To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group.

Zipped files are not supported.

Definition at line 280 of file CloudWatchLogsLogStream.h.

◆ SetFileFingerprintLines() [1/3]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetFileFingerprintLines ( const Aws::String value)
inline

Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.

Definition at line 353 of file CloudWatchLogsLogStream.h.

◆ SetFileFingerprintLines() [2/3]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetFileFingerprintLines ( Aws::String &&  value)
inline

Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.

Definition at line 362 of file CloudWatchLogsLogStream.h.

◆ SetFileFingerprintLines() [3/3]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetFileFingerprintLines ( const char *  value)
inline

Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.

Definition at line 371 of file CloudWatchLogsLogStream.h.

◆ SetInitialPosition() [1/2]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetInitialPosition ( const CloudWatchLogsInitialPosition value)
inline

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.

Definition at line 461 of file CloudWatchLogsLogStream.h.

◆ SetInitialPosition() [2/2]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetInitialPosition ( CloudWatchLogsInitialPosition &&  value)
inline

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.

Definition at line 468 of file CloudWatchLogsLogStream.h.

◆ SetLogGroupName() [1/3]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetLogGroupName ( const Aws::String value)
inline

Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

Definition at line 68 of file CloudWatchLogsLogStream.h.

◆ SetLogGroupName() [2/3]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetLogGroupName ( Aws::String &&  value)
inline

Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

Definition at line 76 of file CloudWatchLogsLogStream.h.

◆ SetLogGroupName() [3/3]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetLogGroupName ( const char *  value)
inline

Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

Definition at line 84 of file CloudWatchLogsLogStream.h.

◆ SetMultiLineStartPattern() [1/3]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetMultiLineStartPattern ( const Aws::String value)
inline

Specifies the pattern for identifying the start of a log message.

Definition at line 414 of file CloudWatchLogsLogStream.h.

◆ SetMultiLineStartPattern() [2/3]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetMultiLineStartPattern ( Aws::String &&  value)
inline

Specifies the pattern for identifying the start of a log message.

Definition at line 419 of file CloudWatchLogsLogStream.h.

◆ SetMultiLineStartPattern() [3/3]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetMultiLineStartPattern ( const char *  value)
inline

Specifies the pattern for identifying the start of a log message.

Definition at line 424 of file CloudWatchLogsLogStream.h.

◆ SetTimeZone() [1/2]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetTimeZone ( const CloudWatchLogsTimeZone value)
inline

Specifies the time zone of log event time stamps.

Definition at line 189 of file CloudWatchLogsLogStream.h.

◆ SetTimeZone() [2/2]

void Aws::OpsWorks::Model::CloudWatchLogsLogStream::SetTimeZone ( CloudWatchLogsTimeZone &&  value)
inline

Specifies the time zone of log event time stamps.

Definition at line 194 of file CloudWatchLogsLogStream.h.

◆ TimeZoneHasBeenSet()

bool Aws::OpsWorks::Model::CloudWatchLogsLogStream::TimeZoneHasBeenSet ( ) const
inline

Specifies the time zone of log event time stamps.

Definition at line 184 of file CloudWatchLogsLogStream.h.

◆ WithBatchCount()

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithBatchCount ( int  value)
inline

Specifies the max number of log events in a batch, up to 10000. The default value is 1000.

Definition at line 575 of file CloudWatchLogsLogStream.h.

◆ WithBatchSize()

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithBatchSize ( int  value)
inline

Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

Definition at line 604 of file CloudWatchLogsLogStream.h.

◆ WithBufferDuration()

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithBufferDuration ( int  value)
inline

Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.

Definition at line 550 of file CloudWatchLogsLogStream.h.

◆ WithDatetimeFormat() [1/3]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithDatetimeFormat ( const Aws::String value)
inline

Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.

Definition at line 157 of file CloudWatchLogsLogStream.h.

◆ WithDatetimeFormat() [2/3]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithDatetimeFormat ( Aws::String &&  value)
inline

Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.

Definition at line 165 of file CloudWatchLogsLogStream.h.

◆ WithDatetimeFormat() [3/3]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithDatetimeFormat ( const char *  value)
inline

Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.

Definition at line 173 of file CloudWatchLogsLogStream.h.

◆ WithEncoding() [1/2]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithEncoding ( const CloudWatchLogsEncoding value)
inline

Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

Definition at line 518 of file CloudWatchLogsLogStream.h.

◆ WithEncoding() [2/2]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithEncoding ( CloudWatchLogsEncoding &&  value)
inline

Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

Definition at line 525 of file CloudWatchLogsLogStream.h.

◆ WithFile() [1/3]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithFile ( const Aws::String value)
inline

Specifies log files that you want to push to CloudWatch Logs.

File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on by using a pattern like access_log.*. Don't use a wildcard to match multiple file types, such as access_log_80 and access_log_443. To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group.

Zipped files are not supported.

Definition at line 295 of file CloudWatchLogsLogStream.h.

◆ WithFile() [2/3]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithFile ( Aws::String &&  value)
inline

Specifies log files that you want to push to CloudWatch Logs.

File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on by using a pattern like access_log.*. Don't use a wildcard to match multiple file types, such as access_log_80 and access_log_443. To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group.

Zipped files are not supported.

Definition at line 310 of file CloudWatchLogsLogStream.h.

◆ WithFile() [3/3]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithFile ( const char *  value)
inline

Specifies log files that you want to push to CloudWatch Logs.

File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on by using a pattern like access_log.*. Don't use a wildcard to match multiple file types, such as access_log_80 and access_log_443. To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group.

Zipped files are not supported.

Definition at line 325 of file CloudWatchLogsLogStream.h.

◆ WithFileFingerprintLines() [1/3]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithFileFingerprintLines ( const Aws::String value)
inline

Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.

Definition at line 380 of file CloudWatchLogsLogStream.h.

◆ WithFileFingerprintLines() [2/3]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithFileFingerprintLines ( Aws::String &&  value)
inline

Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.

Definition at line 389 of file CloudWatchLogsLogStream.h.

◆ WithFileFingerprintLines() [3/3]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithFileFingerprintLines ( const char *  value)
inline

Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.

Definition at line 398 of file CloudWatchLogsLogStream.h.

◆ WithInitialPosition() [1/2]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithInitialPosition ( const CloudWatchLogsInitialPosition value)
inline

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.

Definition at line 475 of file CloudWatchLogsLogStream.h.

◆ WithInitialPosition() [2/2]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithInitialPosition ( CloudWatchLogsInitialPosition &&  value)
inline

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.

Definition at line 482 of file CloudWatchLogsLogStream.h.

◆ WithLogGroupName() [1/3]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithLogGroupName ( const Aws::String value)
inline

Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

Definition at line 92 of file CloudWatchLogsLogStream.h.

◆ WithLogGroupName() [2/3]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithLogGroupName ( Aws::String &&  value)
inline

Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

Definition at line 100 of file CloudWatchLogsLogStream.h.

◆ WithLogGroupName() [3/3]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithLogGroupName ( const char *  value)
inline

Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

Definition at line 108 of file CloudWatchLogsLogStream.h.

◆ WithMultiLineStartPattern() [1/3]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithMultiLineStartPattern ( const Aws::String value)
inline

Specifies the pattern for identifying the start of a log message.

Definition at line 429 of file CloudWatchLogsLogStream.h.

◆ WithMultiLineStartPattern() [2/3]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithMultiLineStartPattern ( Aws::String &&  value)
inline

Specifies the pattern for identifying the start of a log message.

Definition at line 434 of file CloudWatchLogsLogStream.h.

◆ WithMultiLineStartPattern() [3/3]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithMultiLineStartPattern ( const char *  value)
inline

Specifies the pattern for identifying the start of a log message.

Definition at line 439 of file CloudWatchLogsLogStream.h.

◆ WithTimeZone() [1/2]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithTimeZone ( const CloudWatchLogsTimeZone value)
inline

Specifies the time zone of log event time stamps.

Definition at line 199 of file CloudWatchLogsLogStream.h.

◆ WithTimeZone() [2/2]

CloudWatchLogsLogStream& Aws::OpsWorks::Model::CloudWatchLogsLogStream::WithTimeZone ( CloudWatchLogsTimeZone &&  value)
inline

Specifies the time zone of log event time stamps.

Definition at line 204 of file CloudWatchLogsLogStream.h.


The documentation for this class was generated from the following file: