software.amazon.awscdk.services.ecs

Class JsonFileLogDriver.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.JsonFileLogDriver.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<JsonFileLogDriver>

Enclosing class:

JsonFileLogDriver

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

(experimental) A fluent builder for JsonFileLogDriver.

Method Summary

Modifier and Type	Method and Description
JsonFileLogDriver	build()
JsonFileLogDriver.Builder	compress(Boolean compress) (experimental) Toggles compression for rotated logs.
static JsonFileLogDriver.Builder	create()
JsonFileLogDriver.Builder	env(List<String> env) (experimental) The env option takes an array of keys.
JsonFileLogDriver.Builder	envRegex(String envRegex) (experimental) The env-regex option is similar to and compatible with env.
JsonFileLogDriver.Builder	labels(List<String> labels) (experimental) The labels option takes an array of keys.
JsonFileLogDriver.Builder	maxFile(Number maxFile) (experimental) The maximum number of log files that can be present.
JsonFileLogDriver.Builder	maxSize(String maxSize) (experimental) The maximum size of the log before it is rolled.
JsonFileLogDriver.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 JsonFileLogDriver.Builder create()

Returns:

a new instance of JsonFileLogDriver.Builder.

env

@Stability(value=Experimental)
public JsonFileLogDriver.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 JsonFileLogDriver.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 JsonFileLogDriver.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 JsonFileLogDriver.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

compress

@Stability(value=Experimental)
public JsonFileLogDriver.Builder compress(Boolean compress)

(experimental) Toggles compression for rotated logs.

Default: - false

Parameters:

compress - Toggles compression for rotated logs. This parameter is required.

Returns:

this

maxFile

@Stability(value=Experimental)
public JsonFileLogDriver.Builder maxFile(Number maxFile)

(experimental) The maximum number of log files that can be present.

If rolling the logs creates excess files, the oldest file is removed. Only effective when max-size is also set. A positive integer.

Default: - 1

Parameters:

maxFile - The maximum number of log files that can be present. This parameter is required.

Returns:

this

maxSize

@Stability(value=Experimental)
public JsonFileLogDriver.Builder maxSize(String maxSize)

(experimental) The maximum size of the log before it is rolled.

A positive integer plus a modifier representing the unit of measure (k, m, or g).

Default: - -1 (unlimited)

Parameters:

maxSize - The maximum size of the log before it is rolled. This parameter is required.

Returns:

this

build

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

Specified by:

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