UNPKG

1.64 kBTypeScriptView Raw
1import { ContainerDefinition, Secret } from '../container-definition';
2import { BaseLogDriverProps } from './base-log-driver';
3import { LogDriver, LogDriverConfig } from './log-driver';
4import { Construct as CoreConstruct } from '@aws-cdk/core';
5/**
6 * Specifies the firelens log driver configuration options.
7 */
8export interface FireLensLogDriverProps extends BaseLogDriverProps {
9 /**
10 * The configuration options to send to the log driver.
11 * @default - the log driver options
12 */
13 readonly options?: {
14 [key: string]: string;
15 };
16 /**
17 * The secrets to pass to the log configuration.
18 * @default - No secret options provided.
19 */
20 readonly secretOptions?: {
21 [key: string]: Secret;
22 };
23}
24/**
25 * FireLens enables you to use task definition parameters to route logs to an AWS service
26 * or AWS Partner Network (APN) destination for log storage and analytics
27 */
28export declare class FireLensLogDriver extends LogDriver {
29 /**
30 * The configuration options to send to the log driver.
31 * @default - the log driver options
32 */
33 private options?;
34 /**
35 * The secrets to pass to the log configuration.
36 * @default - No secret options provided.
37 */
38 private secretOptions?;
39 /**
40 * Constructs a new instance of the FireLensLogDriver class.
41 * @param props the awsfirelens log driver configuration options.
42 */
43 constructor(props: FireLensLogDriverProps);
44 /**
45 * Called when the log driver is configured on a container
46 */
47 bind(_scope: CoreConstruct, _containerDefinition: ContainerDefinition): LogDriverConfig;
48}