AWS::ECS::TaskDefinition LogConfiguration

The LogConfiguration property specifies log configuration options to send to a custom log driver for the container.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "LogDriver" : String,
  "Options" : {Key: Value, ...},
  "SecretOptions" : [ Secret, ... ]
}

YAML

  LogDriver: String
  Options: 
    Key: Value
  SecretOptions: 
    - Secret

Properties

LogDriver

The log driver to use for the container.

For tasks on AWS Fargate, the supported log drivers are awslogs, splunk, and awsfirelens.

For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

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

For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

Note

If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.

Required: Yes

Type: String

Allowed values: awsfirelens | awslogs | fluentd | gelf | journald | json-file | splunk | syslog

Update requires: Replacement

Options

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

Required: No

Type: Object of String

Pattern: .{1,}

Update requires: Replacement

SecretOptions

The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

Required: No

Type: Array of Secret

Update requires: Replacement