software.amazon.awscdk.services.ecs

Interface SyslogLogDriverProps

All Superinterfaces:

BaseLogDriverProps

All Known Implementing Classes:

SyslogLogDriverProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-02T20:25:37.029Z")
public interface SyslogLogDriverProps
extends BaseLogDriverProps

Specifies the syslog log driver configuration options.

Source

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 SyslogLogDriverProps syslogLogDriverProps = SyslogLogDriverProps.builder()
         .address("address")
         .env(List.of("env"))
         .envRegex("envRegex")
         .facility("facility")
         .format("format")
         .labels(List.of("labels"))
         .tag("tag")
         .tlsCaCert("tlsCaCert")
         .tlsCert("tlsCert")
         .tlsKey("tlsKey")
         .tlsSkipVerify(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SyslogLogDriverProps.Builder A builder for SyslogLogDriverProps
static class	SyslogLogDriverProps.Jsii$Proxy An implementation for SyslogLogDriverProps

Method Summary

Modifier and Type	Method and Description
static SyslogLogDriverProps.Builder	builder()
default java.lang.String	getAddress() The address of an external syslog server.
default java.lang.String	getFacility() The syslog facility to use.
default java.lang.String	getFormat() The syslog message format to use.
default java.lang.String	getTlsCaCert() The absolute path to the trust certificates signed by the CA.
default java.lang.String	getTlsCert() The absolute path to the TLS certificate file.
default java.lang.String	getTlsKey() The absolute path to the TLS key file.
default java.lang.Boolean	getTlsSkipVerify() If set to true, TLS verification is skipped when connecting to the syslog daemon.

Methods inherited from interface software.amazon.awscdk.services.ecs.BaseLogDriverProps

getEnv, getEnvRegex, getLabels, getTag

Method Detail

getAddress

default java.lang.String getAddress()

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.

getFacility

default java.lang.String getFacility()

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

getFormat

default java.lang.String getFormat()

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

getTlsCaCert

default java.lang.String getTlsCaCert()

The absolute path to the trust certificates signed by the CA.

Ignored if the address protocol is not tcp+tls.

Default: - tlsCaCert not set

getTlsCert

default java.lang.String getTlsCert()

The absolute path to the TLS certificate file.

Ignored if the address protocol is not tcp+tls.

Default: - tlsCert not set

getTlsKey

default java.lang.String getTlsKey()

The absolute path to the TLS key file.

Ignored if the address protocol is not tcp+tls.

Default: - tlsKey not set

getTlsSkipVerify

default java.lang.Boolean getTlsSkipVerify()

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

builder

static SyslogLogDriverProps.Builder builder()

Specified by:

builder in interface BaseLogDriverProps

Returns:

a SyslogLogDriverProps.Builder of SyslogLogDriverProps