SyslogLogDriverProps

class aws_cdk.aws_ecs.SyslogLogDriverProps(*, env=None, env_regex=None, labels=None, tag=None, address=None, facility=None, format=None, tls_ca_cert=None, tls_cert=None, tls_key=None, tls_skip_verify=None)

Bases: BaseLogDriverProps

Specifies the syslog log driver configuration options.

Source

Parameters

  • env (Optional[Sequence[str]]) – 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

  • env_regex (Optional[str]) – 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

  • labels (Optional[Sequence[str]]) – 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

  • tag (Optional[str]) – 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

  • address (Optional[str]) – 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.

  • facility (Optional[str]) – 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

  • format (Optional[str]) – 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

  • tls_ca_cert (Optional[str]) – The absolute path to the trust certificates signed by the CA. Ignored if the address protocol is not tcp+tls. Default: - tlsCaCert not set

  • tls_cert (Optional[str]) – The absolute path to the TLS certificate file. Ignored if the address protocol is not tcp+tls. Default: - tlsCert not set

  • tls_key (Optional[str]) – The absolute path to the TLS key file. Ignored if the address protocol is not tcp+tls. Default: - tlsKey not set

  • tls_skip_verify (Optional[bool]) – 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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ecs as ecs

syslog_log_driver_props = ecs.SyslogLogDriverProps(
    address="address",
    env=["env"],
    env_regex="envRegex",
    facility="facility",
    format="format",
    labels=["labels"],
    tag="tag",
    tls_ca_cert="tlsCaCert",
    tls_cert="tlsCert",
    tls_key="tlsKey",
    tls_skip_verify=False
)

Attributes

address

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.

Return type

Optional[str]

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.

Default

  • No env

Return type

Optional[List[str]]

env_regex

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

Return type

Optional[str]

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.

Default

  • facility not set

Return type

Optional[str]

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.

Default

  • format not set

Return type

Optional[str]

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.

Default

  • No labels

Return type

Optional[List[str]]

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.

Default

  • The first 12 characters of the container ID

Return type

Optional[str]

tls_ca_cert

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

Ignored if the address protocol is not tcp+tls.

Default

  • tlsCaCert not set

Return type

Optional[str]

tls_cert

The absolute path to the TLS certificate file.

Ignored if the address protocol is not tcp+tls.

Default

  • tlsCert not set

Return type

Optional[str]

tls_key

The absolute path to the TLS key file.

Ignored if the address protocol is not tcp+tls.

Default

  • tlsKey not set

Return type

Optional[str]

tls_skip_verify

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

Return type

Optional[bool]