SyslogLogDriver.Builder (software.amazon.awscdk:aws-cdk-lib 2.0.0-rc.10 API)

java.lang.Object
- software.amazon.awscdk.services.ecs.SyslogLogDriver.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<SyslogLogDriver>

Enclosing class:: SyslogLogDriver

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

(experimental) A fluent builder for SyslogLogDriver.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SyslogLogDriver.Builder`	`address(String address)` (experimental) The address of an external syslog server.
`SyslogLogDriver`	`build()`
`static SyslogLogDriver.Builder`	`create()`
`SyslogLogDriver.Builder`	`env(List<String> env)` (experimental) The env option takes an array of keys.
`SyslogLogDriver.Builder`	`envRegex(String envRegex)` (experimental) The env-regex option is similar to and compatible with env.
`SyslogLogDriver.Builder`	`facility(String facility)` (experimental) The syslog facility to use.
`SyslogLogDriver.Builder`	`format(String format)` (experimental) The syslog message format to use.
`SyslogLogDriver.Builder`	`labels(List<String> labels)` (experimental) The labels option takes an array of keys.
`SyslogLogDriver.Builder`	`tag(String tag)` (experimental) By default, Docker uses the first 12 characters of the container ID to tag log messages.
`SyslogLogDriver.Builder`	`tlsCaCert(String tlsCaCert)` (experimental) The absolute path to the trust certificates signed by the CA.
`SyslogLogDriver.Builder`	`tlsCert(String tlsCert)` (experimental) The absolute path to the TLS certificate file.
`SyslogLogDriver.Builder`	`tlsKey(String tlsKey)` (experimental) The absolute path to the TLS key file.
`SyslogLogDriver.Builder`	`tlsSkipVerify(Boolean tlsSkipVerify)` (experimental) If set to true, TLS verification is skipped when connecting to the syslog daemon.

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 SyslogLogDriver.Builder create()
```
    Returns:
    
    a new instance of SyslogLogDriver.Builder.
  - env
```
@Stability(value=Experimental)
public SyslogLogDriver.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 SyslogLogDriver.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 SyslogLogDriver.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 SyslogLogDriver.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
  - address
```
@Stability(value=Experimental)
public SyslogLogDriver.Builder address(String address)
```
    (experimental) The address of an external syslog server.
    The URI specifier may be [tcp|udp|tcp+tls]://host:port, unix://path, or unixgram://path.
    Default: - If the transport is tcp, udp, or tcp+tls, the default port is 514.
    
    Parameters:
    
    address - The address of an external syslog server. This parameter is required.
    
    Returns:
    
    this
  - facility
```
@Stability(value=Experimental)
public SyslogLogDriver.Builder facility(String facility)
```
    (experimental) 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.
    Default: - facility not set
    
    Parameters:
    
    facility - The syslog facility to use. This parameter is required.
    
    Returns:
    
    this
  - format
```
@Stability(value=Experimental)
public SyslogLogDriver.Builder format(String format)
```
    (experimental) 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.
    Default: - format not set
    
    Parameters:
    
    format - The syslog message format to use. This parameter is required.
    
    Returns:
    
    this
  - tlsCaCert
```
@Stability(value=Experimental)
public SyslogLogDriver.Builder tlsCaCert(String tlsCaCert)
```
    (experimental) The absolute path to the trust certificates signed by the CA.
    Ignored if the address protocol is not tcp+tls.
    Default: - tlsCaCert not set
    
    Parameters:
    
    tlsCaCert - The absolute path to the trust certificates signed by the CA. This parameter is required.
    
    Returns:
    
    this
  - tlsCert
```
@Stability(value=Experimental)
public SyslogLogDriver.Builder tlsCert(String tlsCert)
```
    (experimental) The absolute path to the TLS certificate file.
    Ignored if the address protocol is not tcp+tls.
    Default: - tlsCert not set
    
    Parameters:
    
    tlsCert - The absolute path to the TLS certificate file. This parameter is required.
    
    Returns:
    
    this
  - tlsKey
```
@Stability(value=Experimental)
public SyslogLogDriver.Builder tlsKey(String tlsKey)
```
    (experimental) The absolute path to the TLS key file.
    Ignored if the address protocol is not tcp+tls.
    Default: - tlsKey not set
    
    Parameters:
    
    tlsKey - The absolute path to the TLS key file. This parameter is required.
    
    Returns:
    
    this
  - tlsSkipVerify
```
@Stability(value=Experimental)
public SyslogLogDriver.Builder tlsSkipVerify(Boolean tlsSkipVerify)
```
    (experimental) If set to true, TLS verification is skipped when connecting to the syslog daemon.
    Ignored if the address protocol is not tcp+tls.
    Default: - false
    
    Parameters:
    
    tlsSkipVerify - If set to true, TLS verification is skipped when connecting to the syslog daemon. This parameter is required.
    
    Returns:
    
    this
  - build
```
@Stability(value=Experimental)
public SyslogLogDriver build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<SyslogLogDriver>

Class SyslogLogDriver.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

env

envRegex

labels

tag

address

facility

format

tlsCaCert

tlsCert

tlsKey

tlsSkipVerify

build