GenericLogDriverProps

class aws_cdk.aws_ecs.GenericLogDriverProps(*, log_driver, options=None, secret_options=None)

Bases: object

The configuration to use when creating a log driver.

Parameters:

log_driver (str) – 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 and splunk. For tasks using the EC2 launch type, the supported log drivers are awslogs, syslog, gelf, fluentd, splunk, journald, and json-file. For more information about using the awslogs log driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.
options (Optional[Mapping[str, str]]) – The configuration options to send to the log driver. Default: - the log driver options.
secret_options (Optional[Mapping[str, Secret]]) – The secrets to pass to the log configuration. Default: - no secret options provided.

ExampleMetadata:

infused

Example:

# Create a Task Definition for the container to start
task_definition = ecs.Ec2TaskDefinition(self, "TaskDef")
task_definition.add_container("TheContainer",
    image=ecs.ContainerImage.from_registry("example-image"),
    memory_limit_mi_b=256,
    logging=ecs.GenericLogDriver(
        log_driver="fluentd",
        options={
            "tag": "example-tag"
        }
    )
)

Attributes

log_driver

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 and splunk. For tasks using the EC2 launch type, the supported log drivers are awslogs, syslog, gelf, fluentd, splunk, journald, and json-file.

For more information about using the awslogs log driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.

options

The configuration options to send to the log driver.

Default:

the log driver options.

secret_options

The secrets to pass to the log configuration.

Default:

no secret options provided.