aws-cdk-lib.aws_ecs.FirelensOptions

interface FirelensOptions

LanguageType name
.NETAmazon.CDK.AWS.ECS.FirelensOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsecs#FirelensOptions
Javasoftware.amazon.awscdk.services.ecs.FirelensOptions
Pythonaws_cdk.aws_ecs.FirelensOptions
TypeScript (source)aws-cdk-lib » aws_ecs » FirelensOptions

The options for firelens log router https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef-customconfig.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
const firelensOptions: ecs.FirelensOptions = {
  configFileType: ecs.FirelensConfigFileType.S3,
  configFileValue: 'configFileValue',
  enableECSLogMetadata: false,
};

Properties

NameTypeDescription
configFileType?FirelensConfigFileTypeCustom configuration file, s3 or file.
configFileValue?stringCustom configuration file, S3 ARN or a file path Both configFileType and configFileValue must be used together to define a custom configuration source.
enableECSLogMetadata?booleanBy default, Amazon ECS adds additional fields in your log entries that help identify the source of the logs.

configFileType?

Type: FirelensConfigFileType (optional, default: determined by checking configFileValue with S3 ARN.)

Custom configuration file, s3 or file.

Both configFileType and configFileValue must be used together to define a custom configuration source.


configFileValue?

Type: string (optional, default: no config file value)

Custom configuration file, S3 ARN or a file path Both configFileType and configFileValue must be used together to define a custom configuration source.


enableECSLogMetadata?

Type: boolean (optional, default: true)

By default, Amazon ECS adds additional fields in your log entries that help identify the source of the logs.

You can disable this action by setting enable-ecs-log-metadata to false.