software.amazon.awscdk.services.ecs

Class AwsLogDriverProps.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.AwsLogDriverProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AwsLogDriverProps>

Enclosing interface:

AwsLogDriverProps

@Stability(value=Stable)
public static final class AwsLogDriverProps.Builder
extends Object
implements software.amazon.jsii.Builder<AwsLogDriverProps>

A builder for AwsLogDriverProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AwsLogDriverProps	build() Builds the configured instance.
AwsLogDriverProps.Builder	datetimeFormat(String datetimeFormat) Sets the value of AwsLogDriverProps.getDatetimeFormat()
AwsLogDriverProps.Builder	logGroup(ILogGroup logGroup) Sets the value of AwsLogDriverProps.getLogGroup()
AwsLogDriverProps.Builder	logRetention(RetentionDays logRetention) Sets the value of AwsLogDriverProps.getLogRetention()
AwsLogDriverProps.Builder	mode(AwsLogDriverMode mode) Sets the value of AwsLogDriverProps.getMode()
AwsLogDriverProps.Builder	multilinePattern(String multilinePattern) Sets the value of AwsLogDriverProps.getMultilinePattern()
AwsLogDriverProps.Builder	streamPrefix(String streamPrefix) Sets the value of AwsLogDriverProps.getStreamPrefix()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

streamPrefix

@Stability(value=Stable)
public AwsLogDriverProps.Builder streamPrefix(String streamPrefix)

Sets the value of AwsLogDriverProps.getStreamPrefix()

Parameters:

streamPrefix - Prefix for the log streams. This parameter is required. 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
                     

Returns:

this

datetimeFormat

@Stability(value=Stable)
public AwsLogDriverProps.Builder datetimeFormat(String datetimeFormat)

Sets the value of AwsLogDriverProps.getDatetimeFormat()

Parameters:

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.

Returns:

this

logGroup

@Stability(value=Stable)
public AwsLogDriverProps.Builder logGroup(ILogGroup logGroup)

Sets the value of AwsLogDriverProps.getLogGroup()

Parameters:

logGroup - The log group to log to.

Returns:

this

logRetention

@Stability(value=Stable)
public AwsLogDriverProps.Builder logRetention(RetentionDays logRetention)

Sets the value of AwsLogDriverProps.getLogRetention()

Parameters:

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

Returns:

this

mode

@Stability(value=Stable)
public AwsLogDriverProps.Builder mode(AwsLogDriverMode mode)

Sets the value of AwsLogDriverProps.getMode()

Parameters:

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

Returns:

this

multilinePattern

@Stability(value=Stable)
public AwsLogDriverProps.Builder multilinePattern(String multilinePattern)

Sets the value of AwsLogDriverProps.getMultilinePattern()

Parameters:

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.

Returns:

this

build

@Stability(value=Stable)
public AwsLogDriverProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<AwsLogDriverProps>

Returns:

a new instance of AwsLogDriverProps

Throws:

NullPointerException - if any required attribute was not provided