Package software.amazon.awscdk.services.ecs

Class JsonFileLogDriverProps.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.JsonFileLogDriverProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<JsonFileLogDriverProps>

Enclosing interface:

JsonFileLogDriverProps

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

A builder for JsonFileLogDriverProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
JsonFileLogDriverProps	build()	Builds the configured instance.
JsonFileLogDriverProps.Builder	compress(Boolean compress)	Sets the value of JsonFileLogDriverProps.getCompress()
JsonFileLogDriverProps.Builder	env(List<String> env)	Sets the value of BaseLogDriverProps.getEnv()
JsonFileLogDriverProps.Builder	envRegex(String envRegex)	Sets the value of BaseLogDriverProps.getEnvRegex()
JsonFileLogDriverProps.Builder	labels(List<String> labels)	Sets the value of BaseLogDriverProps.getLabels()
JsonFileLogDriverProps.Builder	maxFile(Number maxFile)	Sets the value of JsonFileLogDriverProps.getMaxFile()
JsonFileLogDriverProps.Builder	maxSize(String maxSize)	Sets the value of JsonFileLogDriverProps.getMaxSize()
JsonFileLogDriverProps.Builder	tag(String tag)	Sets the value of BaseLogDriverProps.getTag()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

compress

@Stability(Stable)
public JsonFileLogDriverProps.Builder compress(Boolean compress)

Sets the value of JsonFileLogDriverProps.getCompress()

Parameters:

compress - Toggles compression for rotated logs.

Returns:

this

maxFile

@Stability(Stable)
public JsonFileLogDriverProps.Builder maxFile(Number maxFile)

Sets the value of JsonFileLogDriverProps.getMaxFile()

Parameters:

maxFile - 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.

Returns:

this

maxSize

@Stability(Stable)
public JsonFileLogDriverProps.Builder maxSize(String maxSize)

Sets the value of JsonFileLogDriverProps.getMaxSize()

Parameters:

maxSize - 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).

Returns:

this

env

@Stability(Stable)
public JsonFileLogDriverProps.Builder env(List<String> env)

Sets the value of BaseLogDriverProps.getEnv()

Parameters:

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.

Returns:

this

envRegex

@Stability(Stable)
public JsonFileLogDriverProps.Builder envRegex(String envRegex)

Sets the value of BaseLogDriverProps.getEnvRegex()

Parameters:

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.

Returns:

this

labels

@Stability(Stable)
public JsonFileLogDriverProps.Builder labels(List<String> labels)

Sets the value of BaseLogDriverProps.getLabels()

Parameters:

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.

Returns:

this

tag

@Stability(Stable)
public JsonFileLogDriverProps.Builder tag(String tag)

Sets the value of BaseLogDriverProps.getTag()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public JsonFileLogDriverProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of JsonFileLogDriverProps

Throws:

NullPointerException - if any required attribute was not provided