FirelensOptions

class aws_cdk.aws_ecs.FirelensOptions(*, config_file_value, config_file_type=None, enable_ecs_log_metadata=None)

Bases: object

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

Parameters
  • config_file_value (str) – Custom configuration file, S3 ARN or a file path.

  • config_file_type (Optional[FirelensConfigFileType]) – Custom configuration file, s3 or file. Default: - determined by checking configFileValue with S3 ARN.

  • enable_ecs_log_metadata (Optional[bool]) – 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. Default: - true

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ecs as ecs

firelens_options = ecs.FirelensOptions(
    config_file_value="configFileValue",

    # the properties below are optional
    config_file_type=ecs.FirelensConfigFileType.S3,
    enable_eCSLog_metadata=False
)

Attributes

config_file_type

Custom configuration file, s3 or file.

Default
  • determined by checking configFileValue with S3 ARN.

Return type

Optional[FirelensConfigFileType]

config_file_value

Custom configuration file, S3 ARN or a file path.

Return type

str

enable_ecs_log_metadata

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.

Default
  • true

Return type

Optional[bool]