Class SyslogLogDriverProps
Specifies the syslog log driver configuration options.
Inheritance
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SyslogLogDriverProps : Object, ISyslogLogDriverProps, IBaseLogDriverProps
Syntax (vb)
Public Class SyslogLogDriverProps
Inherits Object
Implements ISyslogLogDriverProps, IBaseLogDriverProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ECS;
var syslogLogDriverProps = new SyslogLogDriverProps {
Address = "address",
Env = new [] { "env" },
EnvRegex = "envRegex",
Facility = "facility",
Format = "format",
Labels = new [] { "labels" },
Tag = "tag",
TlsCaCert = "tlsCaCert",
TlsCert = "tlsCert",
TlsKey = "tlsKey",
TlsSkipVerify = false
};
Synopsis
Constructors
SyslogLogDriverProps() |
Properties
Address | The address of an external syslog server. |
Env | The env option takes an array of keys. |
EnvRegex | The env-regex option is similar to and compatible with env. |
Facility | The syslog facility to use. |
Format | The syslog message format to use. |
Labels | The labels option takes an array of keys. |
Tag | By default, Docker uses the first 12 characters of the container ID to tag log messages. |
TlsCaCert | The absolute path to the trust certificates signed by the CA. |
TlsCert | The absolute path to the TLS certificate file. |
TlsKey | The absolute path to the TLS key file. |
TlsSkipVerify | If set to true, TLS verification is skipped when connecting to the syslog daemon. |
Constructors
SyslogLogDriverProps()
public SyslogLogDriverProps()
Properties
Address
The address of an external syslog server.
public string Address { get; set; }
Property Value
System.String
Remarks
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.
Env
The env option takes an array of keys.
public string[] Env { get; set; }
Property Value
System.String[]
Remarks
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
EnvRegex
The env-regex option is similar to and compatible with env.
public string EnvRegex { get; set; }
Property Value
System.String
Remarks
Its value is a regular expression to match logging-related environment variables. It is used for advanced log tag options.
Default: - No envRegex
Facility
The syslog facility to use.
public string Facility { get; set; }
Property Value
System.String
Remarks
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
The syslog message format to use.
public string Format { get; set; }
Property Value
System.String
Remarks
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
Labels
The labels option takes an array of keys.
public string[] Labels { get; set; }
Property Value
System.String[]
Remarks
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
By default, Docker uses the first 12 characters of the container ID to tag log messages.
public string Tag { get; set; }
Property Value
System.String
Remarks
Refer to the log tag option documentation for customizing the log tag format.
Default: - The first 12 characters of the container ID
TlsCaCert
The absolute path to the trust certificates signed by the CA.
public string TlsCaCert { get; set; }
Property Value
System.String
Remarks
Ignored if the address protocol is not tcp+tls.
Default: - tlsCaCert not set
TlsCert
The absolute path to the TLS certificate file.
public string TlsCert { get; set; }
Property Value
System.String
Remarks
Ignored if the address protocol is not tcp+tls.
Default: - tlsCert not set
TlsKey
The absolute path to the TLS key file.
public string TlsKey { get; set; }
Property Value
System.String
Remarks
Ignored if the address protocol is not tcp+tls.
Default: - tlsKey not set
TlsSkipVerify
If set to true, TLS verification is skipped when connecting to the syslog daemon.
public Nullable<bool> TlsSkipVerify { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Ignored if the address protocol is not tcp+tls.
Default: - false