81 lines
2.7 KiB
TypeScript
81 lines
2.7 KiB
TypeScript
import type { Construct } from 'constructs';
|
|
import type { BaseLogDriverProps } from './base-log-driver';
|
|
import type { LogDriverConfig } from './log-driver';
|
|
import { LogDriver } from './log-driver';
|
|
import type { ContainerDefinition } from '../container-definition';
|
|
/**
|
|
* Specifies the syslog log driver configuration options.
|
|
*
|
|
* [Source](https://docs.docker.com/config/containers/logging/syslog/)
|
|
*/
|
|
export interface SyslogLogDriverProps extends BaseLogDriverProps {
|
|
/**
|
|
* 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.
|
|
*/
|
|
readonly address?: string;
|
|
/**
|
|
* 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
|
|
*/
|
|
readonly facility?: string;
|
|
/**
|
|
* The absolute path to the trust certificates signed by the CA. Ignored
|
|
* if the address protocol is not tcp+tls.
|
|
*
|
|
* @default - tlsCaCert not set
|
|
*/
|
|
readonly tlsCaCert?: string;
|
|
/**
|
|
* The absolute path to the TLS certificate file. Ignored if the address
|
|
* protocol is not tcp+tls.
|
|
*
|
|
* @default - tlsCert not set
|
|
*/
|
|
readonly tlsCert?: string;
|
|
/**
|
|
* The absolute path to the TLS key file. Ignored if the address protocol
|
|
* is not tcp+tls.
|
|
*
|
|
* @default - tlsKey not set
|
|
*/
|
|
readonly tlsKey?: string;
|
|
/**
|
|
* 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
|
|
*/
|
|
readonly tlsSkipVerify?: boolean;
|
|
/**
|
|
* 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
|
|
*/
|
|
readonly format?: string;
|
|
}
|
|
/**
|
|
* A log driver that sends log information to syslog Logs.
|
|
*/
|
|
export declare class SyslogLogDriver extends LogDriver {
|
|
private readonly props;
|
|
/**
|
|
* Constructs a new instance of the SyslogLogDriver class.
|
|
*
|
|
* @param props the syslog log driver configuration options.
|
|
*/
|
|
constructor(props?: SyslogLogDriverProps);
|
|
/**
|
|
* Called when the log driver is configured on a container
|
|
*/
|
|
bind(_scope: Construct, _containerDefinition: ContainerDefinition): LogDriverConfig;
|
|
}
|