software.amazon.awscdk.services.ecs

Class FluentdLogDriver.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.FluentdLogDriver.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FluentdLogDriver>

Enclosing class:

FluentdLogDriver

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

(experimental) A fluent builder for FluentdLogDriver.

Method Summary

Modifier and Type	Method and Description
FluentdLogDriver.Builder	address(String address) (experimental) By default, the logging driver connects to localhost:24224.
FluentdLogDriver.Builder	asyncConnect(Boolean asyncConnect) (experimental) Docker connects to Fluentd in the background.
FluentdLogDriver.Builder	bufferLimit(Number bufferLimit) (experimental) The amount of data to buffer before flushing to disk.
FluentdLogDriver	build()
static FluentdLogDriver.Builder	create()
FluentdLogDriver.Builder	env(List<String> env) (experimental) The env option takes an array of keys.
FluentdLogDriver.Builder	envRegex(String envRegex) (experimental) The env-regex option is similar to and compatible with env.
FluentdLogDriver.Builder	labels(List<String> labels) (experimental) The labels option takes an array of keys.
FluentdLogDriver.Builder	maxRetries(Number maxRetries) (experimental) The maximum number of retries.
FluentdLogDriver.Builder	retryWait(Duration retryWait) (experimental) How long to wait between retries.
FluentdLogDriver.Builder	subSecondPrecision(Boolean subSecondPrecision) (experimental) Generates event logs in nanosecond resolution.
FluentdLogDriver.Builder	tag(String tag) (experimental) By default, Docker uses the first 12 characters of the container ID to tag log messages.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static FluentdLogDriver.Builder create()

Returns:

a new instance of FluentdLogDriver.Builder.

env

@Stability(value=Experimental)
public FluentdLogDriver.Builder env(List<String> env)

(experimental) The env option takes an array of keys.

If there is collision between label and env keys, the value of the env takes precedence. Adds additional fields to the extra attributes of a logging message.

Default: - No env

Parameters:

env - The env option takes an array of keys. This parameter is required.

Returns:

this

envRegex

@Stability(value=Experimental)
public FluentdLogDriver.Builder envRegex(String envRegex)

(experimental) The env-regex option is similar to and compatible with env.

Its value is a regular expression to match logging-related environment variables. It is used for advanced log tag options.

Default: - No envRegex

Parameters:

envRegex - The env-regex option is similar to and compatible with env. This parameter is required.

Returns:

this

labels

@Stability(value=Experimental)
public FluentdLogDriver.Builder labels(List<String> labels)

(experimental) The labels option takes an array of keys.

If there is collision between label and env keys, the value of the env takes precedence. Adds additional fields to the extra attributes of a logging message.

Default: - No labels

Parameters:

labels - The labels option takes an array of keys. This parameter is required.

Returns:

this

tag

@Stability(value=Experimental)
public FluentdLogDriver.Builder tag(String tag)

(experimental) By default, Docker uses the first 12 characters of the container ID to tag log messages.

Refer to the log tag option documentation for customizing the log tag format.

Default: - The first 12 characters of the container ID

Parameters:

tag - By default, Docker uses the first 12 characters of the container ID to tag log messages. This parameter is required.

Returns:

this

address

@Stability(value=Experimental)
public FluentdLogDriver.Builder address(String address)

(experimental) By default, the logging driver connects to localhost:24224.

Supply the address option to connect to a different address. tcp(default) and unix sockets are supported.

Default: - address not set.

Parameters:

address - By default, the logging driver connects to localhost:24224. This parameter is required.

Returns:

this

asyncConnect

@Stability(value=Experimental)
public FluentdLogDriver.Builder asyncConnect(Boolean asyncConnect)

(experimental) Docker connects to Fluentd in the background.

Messages are buffered until the connection is established.

Default: - false

Parameters:

asyncConnect - Docker connects to Fluentd in the background. This parameter is required.

Returns:

this

bufferLimit

@Stability(value=Experimental)
public FluentdLogDriver.Builder bufferLimit(Number bufferLimit)

(experimental) The amount of data to buffer before flushing to disk.

Default: - The amount of RAM available to the container.

Parameters:

bufferLimit - The amount of data to buffer before flushing to disk. This parameter is required.

Returns:

this

maxRetries

@Stability(value=Experimental)
public FluentdLogDriver.Builder maxRetries(Number maxRetries)

(experimental) The maximum number of retries.

Default: - 4294967295 (2**32 - 1).

Parameters:

maxRetries - The maximum number of retries. This parameter is required.

Returns:

this

retryWait

@Stability(value=Experimental)
public FluentdLogDriver.Builder retryWait(Duration retryWait)

(experimental) How long to wait between retries.

Default: - 1 second

Parameters:

retryWait - How long to wait between retries. This parameter is required.

Returns:

this

subSecondPrecision

@Stability(value=Experimental)
public FluentdLogDriver.Builder subSecondPrecision(Boolean subSecondPrecision)

(experimental) Generates event logs in nanosecond resolution.

Default: - false

Parameters:

subSecondPrecision - Generates event logs in nanosecond resolution. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public FluentdLogDriver build()

Specified by:

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