@aws-cdk/aws-ecs
Version:
The CDK Construct Library for AWS::ECS
51 lines (50 loc) • 2.11 kB
TypeScript
import { ContainerDefinition } from '../container-definition';
import { CfnTaskDefinition } from '../ecs.generated';
import { AwsLogDriverProps } from './aws-log-driver';
import { Construct as CoreConstruct } from '@aws-cdk/core';
/**
* The base class for log drivers.
*/
export declare abstract class LogDriver {
/**
* Creates a log driver configuration that sends log information to CloudWatch Logs.
*/
static awsLogs(props: AwsLogDriverProps): LogDriver;
/**
* Called when the log driver is configured on a container
*/
abstract bind(scope: CoreConstruct, containerDefinition: ContainerDefinition): LogDriverConfig;
}
/**
* The configuration to use when creating a log driver.
*/
export interface LogDriverConfig {
/**
* 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, splunk, and awsfirelens.
* For tasks using the EC2 launch type, the supported log drivers are awslogs, fluentd, gelf, json-file, journald,
* logentries,syslog, splunk, and awsfirelens.
*
* 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.
*
* For more information about using the awsfirelens log driver, see
* [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html)
* in the Amazon Elastic Container Service Developer Guide.
*/
readonly logDriver: string;
/**
* The configuration options to send to the log driver.
*/
readonly options?: {
[key: string]: string;
};
/**
* The secrets to pass to the log configuration.
* @default - No secret options provided.
*/
readonly secretOptions?: CfnTaskDefinition.SecretProperty[];
}