class Aws::Batch::Types::LogConfiguration

Log configuration options to send to a custom log driver for the container.

@note When making an API call, you may pass LogConfiguration

data as a hash:

    {
      log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk
      options: {
        "String" => "String",
      },
      secret_options: [
        {
          name: "String", # required
          value_from: "String", # required
        },
      ],
    }

@!attribute [rw] 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.

The supported log drivers are `awslogs`, `fluentd`, `gelf`,
`json-file`, `journald`, `logentries`, `syslog`, and `splunk`.

<note markdown="1"> Jobs that are running on Fargate resources are restricted to the
`awslogs` and `splunk` log drivers.

 </note>

awslogs

: Specifies the Amazon CloudWatch Logs logging driver. For more
  information, see [Using the awslogs Log Driver][1] in the *Batch
  User Guide* and [Amazon CloudWatch Logs logging driver][2] in the
  Docker documentation.

fluentd

: Specifies the Fluentd logging driver. For more information,
  including usage and options, see [Fluentd logging driver][3] in
  the Docker documentation.

gelf

: Specifies the Graylog Extended Format (GELF) logging driver. For
  more information, including usage and options, see [Graylog
  Extended Format logging driver][4] in the Docker documentation.

journald

: Specifies the journald logging driver. For more information,
  including usage and options, see [Journald logging driver][5] in
  the Docker documentation.

json-file

: Specifies the JSON file logging driver. For more information,
  including usage and options, see [JSON File logging driver][6] in
  the Docker documentation.

splunk

: Specifies the Splunk logging driver. For more information,
  including usage and options, see [Splunk logging driver][7] in the
  Docker documentation.

syslog

: Specifies the syslog logging driver. For more information,
  including usage and options, see [Syslog logging driver][8] in the
  Docker documentation.

<note markdown="1"> If you have a custom driver that's not listed earlier that you want
to work with the Amazon ECS container agent, you can fork the Amazon
ECS container agent project that's [available on GitHub][9] and
customize it to work with that driver. We encourage you to submit
pull requests for changes that you want to have included. However,
Amazon Web Services doesn't currently support running modified
copies of this software.

 </note>

This parameter requires version 1.18 of the Docker Remote API or
greater on your container instance. To check the Docker Remote API
version on your container instance, log into your container instance
and run the following command: `sudo docker version | grep "Server
API version"`

[1]: https://docs.aws.amazon.com/batch/latest/userguide/using_awslogs.html
[2]: https://docs.docker.com/config/containers/logging/awslogs/
[3]: https://docs.docker.com/config/containers/logging/fluentd/
[4]: https://docs.docker.com/config/containers/logging/gelf/
[5]: https://docs.docker.com/config/containers/logging/journald/
[6]: https://docs.docker.com/config/containers/logging/json-file/
[7]: https://docs.docker.com/config/containers/logging/splunk/
[8]: https://docs.docker.com/config/containers/logging/syslog/
[9]: https://github.com/aws/amazon-ecs-agent
@return [String]

@!attribute [rw] 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 into your container instance and run the
following command: `sudo docker version | grep "Server API version"`
@return [Hash<String,String>]

@!attribute [rw] secret_options

The secrets to pass to the log configuration. For more information,
see [Specifying Sensitive Data][1] in the *Batch User Guide*.

[1]: https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html
@return [Array<Types::Secret>]

@see docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/LogConfiguration AWS API Documentation

Constants

SENSITIVE