You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ECS::Types::LogConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing LogConfiguration as input to an Aws::Client method, you can use a vanilla 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
    },
  ],
}

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#log_driverString

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, fluentd, gelf, json-file, journald, logentries, syslog, splunk, and syslog.

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

If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is 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, Amazon Web Services does not currently support running modified copies of this software.

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 in to your container instance and run the following command: sudo docker version --format '`{{.Server.APIVersion}}`'

Returns:

  • (String)

    The log driver to use for the container.

#optionsHash<String,String>

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}}`'

Returns:

  • (Hash<String,String>)

    The configuration options to send to the log driver.

#secret_optionsArray<Types::Secret>

The secrets to pass to the log configuration.

Returns:

  • (Array<Types::Secret>)

    The secrets to pass to the log configuration.