software.amazon.awscdk.services.ecs

Class AwsLogDriver.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.AwsLogDriver.Builder

Enclosing class:

AwsLogDriver

public static final class AwsLogDriver.Builder
extends java.lang.Object

A fluent builder for AwsLogDriver.

Method Summary

Modifier and Type	Method and Description
AwsLogDriver	build()
static AwsLogDriver.Builder	create()
AwsLogDriver.Builder	datetimeFormat(java.lang.String datetimeFormat) This option defines a multiline start pattern in Python strftime format.
AwsLogDriver.Builder	logGroup(ILogGroup logGroup) The log group to log to.
AwsLogDriver.Builder	logRetention(RetentionDays logRetention) The number of days log events are kept in CloudWatch Logs when the log group is automatically created by this construct.
AwsLogDriver.Builder	mode(AwsLogDriverMode mode) The delivery mode of log messages from the container to awslogs.
AwsLogDriver.Builder	multilinePattern(java.lang.String multilinePattern) This option defines a multiline start pattern using a regular expression.
AwsLogDriver.Builder	streamPrefix(java.lang.String streamPrefix) Prefix for the log streams.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static AwsLogDriver.Builder create()

Returns:

a new instance of AwsLogDriver.Builder.

streamPrefix

public AwsLogDriver.Builder streamPrefix(java.lang.String streamPrefix)

Prefix for the log streams.

The awslogs-stream-prefix option allows you to associate a log stream with the specified prefix, the container name, and the ID of the Amazon ECS task to which the container belongs. If you specify a prefix with this option, then the log stream takes the following format:

  prefix-name/container-name/ecs-task-id
 

Parameters:

streamPrefix - Prefix for the log streams. This parameter is required.

Returns:

this

datetimeFormat

public AwsLogDriver.Builder datetimeFormat(java.lang.String datetimeFormat)

This option defines a multiline start pattern in Python strftime format.

A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. Thus the matched line is the delimiter between log messages.

Default: - No multiline matching.

Parameters:

datetimeFormat - This option defines a multiline start pattern in Python strftime format. This parameter is required.

Returns:

this

logGroup

public AwsLogDriver.Builder logGroup(ILogGroup logGroup)

The log group to log to.

Default: - A log group is automatically created.

Parameters:

logGroup - The log group to log to. This parameter is required.

Returns:

this

logRetention

public AwsLogDriver.Builder logRetention(RetentionDays logRetention)

The number of days log events are kept in CloudWatch Logs when the log group is automatically created by this construct.

Default: - Logs never expire.

Parameters:

logRetention - The number of days log events are kept in CloudWatch Logs when the log group is automatically created by this construct. This parameter is required.

Returns:

this

mode

public AwsLogDriver.Builder mode(AwsLogDriverMode mode)

The delivery mode of log messages from the container to awslogs.

Default: - AwsLogDriverMode.BLOCKING

Parameters:

mode - The delivery mode of log messages from the container to awslogs. This parameter is required.

Returns:

this

multilinePattern

public AwsLogDriver.Builder multilinePattern(java.lang.String multilinePattern)

This option defines a multiline start pattern using a regular expression.

A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. Thus the matched line is the delimiter between log messages.

This option is ignored if datetimeFormat is also configured.

Default: - No multiline matching.

Parameters:

multilinePattern - This option defines a multiline start pattern using a regular expression. This parameter is required.

Returns:

this

build

public AwsLogDriver build()