69 lines
2.6 KiB
TypeScript
69 lines
2.6 KiB
TypeScript
import type { Construct } from 'constructs';
|
|
import type { LogDriverConfig } from './log-driver';
|
|
import { LogDriver } from './log-driver';
|
|
import type { ContainerDefinition, Secret } from '../container-definition';
|
|
/**
|
|
* The configuration to use when creating a log driver.
|
|
*/
|
|
export interface GenericLogDriverProps {
|
|
/**
|
|
* The log driver to use for the container. The valid values listed for this parameter are log drivers
|
|
* that the Amazon ECS container agent can communicate with by default.
|
|
*
|
|
* For tasks using the Fargate launch type, the supported log drivers are awslogs and splunk.
|
|
* For tasks using the EC2 launch type, the supported log drivers are awslogs, syslog, gelf, fluentd, splunk, journald, and json-file.
|
|
*
|
|
* For more information about using the awslogs log driver, see
|
|
* [Using the awslogs Log Driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html)
|
|
* in the Amazon Elastic Container Service Developer Guide.
|
|
*/
|
|
readonly logDriver: string;
|
|
/**
|
|
* The configuration options to send to the log driver.
|
|
* @default - the log driver options.
|
|
*/
|
|
readonly options?: {
|
|
[key: string]: string;
|
|
};
|
|
/**
|
|
* The secrets to pass to the log configuration.
|
|
* @default - no secret options provided.
|
|
*/
|
|
readonly secretOptions?: {
|
|
[key: string]: Secret;
|
|
};
|
|
}
|
|
/**
|
|
* A log driver that sends logs to the specified driver.
|
|
*/
|
|
export declare class GenericLogDriver extends LogDriver {
|
|
/**
|
|
* The log driver to use for the container. The valid values listed for this parameter are log drivers
|
|
* that the Amazon ECS container agent can communicate with by default. You cannot use awslogs with the GenericLogDriver.
|
|
* You must use the AwsLogDriver if you want to use awslogs.
|
|
*
|
|
* For tasks using the Fargate launch type, the supported log drivers are awslogs and splunk.
|
|
* For tasks using the EC2 launch type, the supported log drivers are awslogs, syslog, gelf, fluentd, splunk, journald, and json-file.
|
|
*
|
|
*/
|
|
private logDriver;
|
|
/**
|
|
* The configuration options to send to the log driver.
|
|
*/
|
|
private options;
|
|
/**
|
|
* The secrets to pass to the log configuration.
|
|
*/
|
|
private secretOptions?;
|
|
/**
|
|
* Constructs a new instance of the GenericLogDriver class.
|
|
*
|
|
* @param props the generic log driver configuration options.
|
|
*/
|
|
constructor(props: GenericLogDriverProps);
|
|
/**
|
|
* Called when the log driver is configured on a container.
|
|
*/
|
|
bind(_scope: Construct, _containerDefinition: ContainerDefinition): LogDriverConfig;
|
|
}
|