software.amazon.awscdk.services.ecs

Class FireLensLogDriver.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.FireLensLogDriver.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FireLensLogDriver>

Enclosing class:

FireLensLogDriver

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

A fluent builder for FireLensLogDriver.

Method Summary

Modifier and Type	Method and Description
FireLensLogDriver	build()
static FireLensLogDriver.Builder	create()
FireLensLogDriver.Builder	env(List<String> env) The env option takes an array of keys.
FireLensLogDriver.Builder	envRegex(String envRegex) The env-regex option is similar to and compatible with env.
FireLensLogDriver.Builder	labels(List<String> labels) The labels option takes an array of keys.
FireLensLogDriver.Builder	options(Map<String,String> options) The configuration options to send to the log driver.
FireLensLogDriver.Builder	secretOptions(Map<String,? extends Secret> secretOptions) The secrets to pass to the log configuration.
FireLensLogDriver.Builder	tag(String tag) 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=Stable)
public static FireLensLogDriver.Builder create()

Returns:

a new instance of FireLensLogDriver.Builder.

env

@Stability(value=Stable)
public FireLensLogDriver.Builder env(List<String> env)

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=Stable)
public FireLensLogDriver.Builder envRegex(String envRegex)

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=Stable)
public FireLensLogDriver.Builder labels(List<String> labels)

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=Stable)
public FireLensLogDriver.Builder tag(String tag)

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

options

@Stability(value=Stable)
public FireLensLogDriver.Builder options(Map<String,String> options)

The configuration options to send to the log driver.

Default: - the log driver options

Parameters:

options - The configuration options to send to the log driver. This parameter is required.

Returns:

this

secretOptions

@Stability(value=Stable)
public FireLensLogDriver.Builder secretOptions(Map<String,? extends Secret> secretOptions)

The secrets to pass to the log configuration.

Default: - No secret options provided.

Parameters:

secretOptions - The secrets to pass to the log configuration. This parameter is required.

Returns:

this

build

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

Specified by:

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