Package software.amazon.awscdk.services.ecs

Class SyslogLogDriverProps.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.SyslogLogDriverProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SyslogLogDriverProps>

Enclosing interface:

SyslogLogDriverProps

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

A builder for SyslogLogDriverProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SyslogLogDriverProps.Builder	address(String address)	Sets the value of SyslogLogDriverProps.getAddress()
SyslogLogDriverProps	build()	Builds the configured instance.
SyslogLogDriverProps.Builder	env(List<String> env)	Sets the value of BaseLogDriverProps.getEnv()
SyslogLogDriverProps.Builder	envRegex(String envRegex)	Sets the value of BaseLogDriverProps.getEnvRegex()
SyslogLogDriverProps.Builder	facility(String facility)	Sets the value of SyslogLogDriverProps.getFacility()
SyslogLogDriverProps.Builder	format(String format)	Sets the value of SyslogLogDriverProps.getFormat()
SyslogLogDriverProps.Builder	labels(List<String> labels)	Sets the value of BaseLogDriverProps.getLabels()
SyslogLogDriverProps.Builder	tag(String tag)	Sets the value of BaseLogDriverProps.getTag()
SyslogLogDriverProps.Builder	tlsCaCert(String tlsCaCert)	Sets the value of SyslogLogDriverProps.getTlsCaCert()
SyslogLogDriverProps.Builder	tlsCert(String tlsCert)	Sets the value of SyslogLogDriverProps.getTlsCert()
SyslogLogDriverProps.Builder	tlsKey(String tlsKey)	Sets the value of SyslogLogDriverProps.getTlsKey()
SyslogLogDriverProps.Builder	tlsSkipVerify(Boolean tlsSkipVerify)	Sets the value of SyslogLogDriverProps.getTlsSkipVerify()

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 SyslogLogDriverProps.Builder address(String address)

Sets the value of SyslogLogDriverProps.getAddress()

Parameters:

address - The address of an external syslog server. The URI specifier may be [tcp|udp|tcp+tls]://host:port, unix://path, or unixgram://path.

Returns:

this

facility

@Stability(Stable)
public SyslogLogDriverProps.Builder facility(String facility)

Sets the value of SyslogLogDriverProps.getFacility()

Parameters:

facility - The syslog facility to use. Can be the number or name for any valid syslog facility. See the syslog documentation: https://tools.ietf.org/html/rfc5424#section-6.2.1.

Returns:

this

format

@Stability(Stable)
public SyslogLogDriverProps.Builder format(String format)

Sets the value of SyslogLogDriverProps.getFormat()

Parameters:

format - The syslog message format to use. If not specified the local UNIX syslog format is used, without a specified hostname. Specify rfc3164 for the RFC-3164 compatible format, rfc5424 for RFC-5424 compatible format, or rfc5424micro for RFC-5424 compatible format with microsecond timestamp resolution.

Returns:

this

tlsCaCert

@Stability(Stable)
public SyslogLogDriverProps.Builder tlsCaCert(String tlsCaCert)

Sets the value of SyslogLogDriverProps.getTlsCaCert()

Parameters:

tlsCaCert - The absolute path to the trust certificates signed by the CA. Ignored if the address protocol is not tcp+tls.

Returns:

this

tlsCert

@Stability(Stable)
public SyslogLogDriverProps.Builder tlsCert(String tlsCert)

Sets the value of SyslogLogDriverProps.getTlsCert()

Parameters:

tlsCert - The absolute path to the TLS certificate file. Ignored if the address protocol is not tcp+tls.

Returns:

this

tlsKey

@Stability(Stable)
public SyslogLogDriverProps.Builder tlsKey(String tlsKey)

Sets the value of SyslogLogDriverProps.getTlsKey()

Parameters:

tlsKey - The absolute path to the TLS key file. Ignored if the address protocol is not tcp+tls.

Returns:

this

tlsSkipVerify

@Stability(Stable)
public SyslogLogDriverProps.Builder tlsSkipVerify(Boolean tlsSkipVerify)

Sets the value of SyslogLogDriverProps.getTlsSkipVerify()

Parameters:

tlsSkipVerify - If set to true, TLS verification is skipped when connecting to the syslog daemon. Ignored if the address protocol is not tcp+tls.

Returns:

this

env

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SyslogLogDriverProps

Throws:

NullPointerException - if any required attribute was not provided