Skip to content

FirelensConfiguration

Source code in docs_src/capo_batch/types/firelens_configuration.py 
12
13
14
15
16
17
18
19
20
class FirelensConfiguration(TypedDict, closed=True):
    type: NotRequired[
        "capo_batch.types.firelens_configuration_type.FirelensConfigurationType"
    ]
    """<p>The log router to use. The valid values are <code>fluentd</code> or <code>fluentbit</code>.</p>"""
    options: NotRequired[
        "capo_batch.types.firelens_configuration_options_map.FirelensConfigurationOptionsMap"
    ]
    """<p>The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is <code>"options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef">Creating a task definition that uses a FireLens configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"""

options instance-attribute 

options: NotRequired[FirelensConfigurationOptionsMap]

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a task definition that uses a FireLens configuration in the Amazon Elastic Container Service Developer Guide.

type instance-attribute 

type: NotRequired[FirelensConfigurationType]

The log router to use. The valid values are fluentd or fluentbit.