Package software.amazon.awscdk.services.ecs

Class GelfLogDriverProps.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.GelfLogDriverProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GelfLogDriverProps>

Enclosing interface:

GelfLogDriverProps

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

A builder for GelfLogDriverProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GelfLogDriverProps.Builder	address(String address)	Sets the value of GelfLogDriverProps.getAddress()
GelfLogDriverProps	build()	Builds the configured instance.
GelfLogDriverProps.Builder	compressionLevel(Number compressionLevel)	Sets the value of GelfLogDriverProps.getCompressionLevel()
GelfLogDriverProps.Builder	compressionType(GelfCompressionType compressionType)	Sets the value of GelfLogDriverProps.getCompressionType()
GelfLogDriverProps.Builder	env(List<String> env)	Sets the value of BaseLogDriverProps.getEnv()
GelfLogDriverProps.Builder	envRegex(String envRegex)	Sets the value of BaseLogDriverProps.getEnvRegex()
GelfLogDriverProps.Builder	labels(List<String> labels)	Sets the value of BaseLogDriverProps.getLabels()
GelfLogDriverProps.Builder	tag(String tag)	Sets the value of BaseLogDriverProps.getTag()
GelfLogDriverProps.Builder	tcpMaxReconnect(Number tcpMaxReconnect)	Sets the value of GelfLogDriverProps.getTcpMaxReconnect()
GelfLogDriverProps.Builder	tcpReconnectDelay(Duration tcpReconnectDelay)	Sets the value of GelfLogDriverProps.getTcpReconnectDelay()

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

address

@Stability(Stable)
public GelfLogDriverProps.Builder address(String address)

Sets the value of GelfLogDriverProps.getAddress()

Parameters:

address - The address of the GELF server. This parameter is required. tcp and udp are the only supported URI specifier and you must specify the port.

Returns:

this

compressionLevel

@Stability(Stable)
public GelfLogDriverProps.Builder compressionLevel(Number compressionLevel)

Sets the value of GelfLogDriverProps.getCompressionLevel()

Parameters:

compressionLevel - UDP Only The level of compression when gzip or zlib is the gelf-compression-type. An integer in the range of -1 to 9 (BestCompression). Higher levels provide more compression at lower speed. Either -1 or 0 disables compression.

Returns:

this

compressionType

@Stability(Stable)
public GelfLogDriverProps.Builder compressionType(GelfCompressionType compressionType)

Sets the value of GelfLogDriverProps.getCompressionType()

Parameters:

compressionType - UDP Only The type of compression the GELF driver uses to compress each log message. Allowed values are gzip, zlib and none.

Returns:

this

tcpMaxReconnect

@Stability(Stable)
public GelfLogDriverProps.Builder tcpMaxReconnect(Number tcpMaxReconnect)

Sets the value of GelfLogDriverProps.getTcpMaxReconnect()

Parameters:

tcpMaxReconnect - TCP Only The maximum number of reconnection attempts when the connection drop. A positive integer.

Returns:

this

tcpReconnectDelay

@Stability(Stable)
public GelfLogDriverProps.Builder tcpReconnectDelay(Duration tcpReconnectDelay)

Sets the value of GelfLogDriverProps.getTcpReconnectDelay()

Parameters:

tcpReconnectDelay - TCP Only The number of seconds to wait between reconnection attempts. A positive integer.

Returns:

this

env

@Stability(Stable)
public GelfLogDriverProps.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 GelfLogDriverProps.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 GelfLogDriverProps.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 GelfLogDriverProps.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 GelfLogDriverProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of GelfLogDriverProps

Throws:

NullPointerException - if any required attribute was not provided