2.169.0

interface SyslogLogDriverProps

LanguageType name
.NETAmazon.CDK.AWS.ECS.SyslogLogDriverProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsecs#SyslogLogDriverProps
Javasoftware.amazon.awscdk.services.ecs.SyslogLogDriverProps
Pythonaws_cdk.aws_ecs.SyslogLogDriverProps
TypeScript (source)aws-cdk-lib » aws_ecs » SyslogLogDriverProps

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 { aws_ecs as ecs } from 'aws-cdk-lib';
const syslogLogDriverProps: ecs.SyslogLogDriverProps = {
  address: 'address',
  env: ['env'],
  envRegex: 'envRegex',
  facility: 'facility',
  format: 'format',
  labels: ['labels'],
  tag: 'tag',
  tlsCaCert: 'tlsCaCert',
  tlsCert: 'tlsCert',
  tlsKey: 'tlsKey',
  tlsSkipVerify: false,
};

Properties

NameTypeDescription
address?stringThe address of an external syslog server.
env?string[]The env option takes an array of keys.
envRegex?stringThe env-regex option is similar to and compatible with env.
facility?stringThe syslog facility to use.
format?stringThe syslog message format to use.
labels?string[]The labels option takes an array of keys.
tag?stringBy default, Docker uses the first 12 characters of the container ID to tag log messages.
tlsCaCert?stringThe absolute path to the trust certificates signed by the CA.
tlsCert?stringThe absolute path to the TLS certificate file.
tlsKey?stringThe absolute path to the TLS key file.
tlsSkipVerify?booleanIf set to true, TLS verification is skipped when connecting to the syslog daemon.

address?

Type: string (optional, default: If the transport is tcp, udp, or tcp+tls, the default port is 514.)

The address of an external syslog server.

The URI specifier may be [tcp|udp|tcp+tls]://host:port, unix://path, or unixgram://path.

env?

Type: string[] (optional, default: No 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.

envRegex?

Type: string (optional, default: No 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.

facility?

Type: string (optional, default: facility not set)

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.

format?

Type: string (optional, default: format not set)

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.

labels?

Type: string[] (optional, default: No 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.

tag?

Type: string (optional, default: The first 12 characters of the container ID)

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.

tlsCaCert?

Type: string (optional, default: tlsCaCert not set)

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

Ignored if the address protocol is not tcp+tls.

tlsCert?

Type: string (optional, default: tlsCert not set)

The absolute path to the TLS certificate file.

Ignored if the address protocol is not tcp+tls.

tlsKey?

Type: string (optional, default: tlsKey not set)

The absolute path to the TLS key file.

Ignored if the address protocol is not tcp+tls.

tlsSkipVerify?

Type: boolean (optional, default: false)

If set to true, TLS verification is skipped when connecting to the syslog daemon.

Ignored if the address protocol is not tcp+tls.

← PreviousNext →