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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

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, awsfirelens
  options: {
    "String" => "String",
  },
  secret_options: [
    {
      name: "String", # required
      value_from: "String", # required
    },
  ],
}

The log configuration for the container. This parameter maps to `LogConfig` in the [Create a container] section of the [Docker Remote API] and the `–log-driver` option to [ `docker run` ][3].

By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information on the options for different supported log drivers, see [Configure logging drivers] in the Docker documentation.

The following should be noted when specifying a log configuration for your containers:

  • Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the valid values below). Additional log drivers may be available in future releases of the Amazon ECS container agent.

  • This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.

  • For tasks hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration] in the *Amazon Elastic Container Service Developer Guide*.

  • For tasks on Fargate, because you do not have access to the underlying infrastructure your tasks are hosted on, any additional software needed will have to be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.

[1]: docs.docker.com/engine/api/v1.35/#operation/ContainerCreate [2]: docs.docker.com/engine/api/v1.35/ [3]: docs.docker.com/engine/reference/commandline/run/ [4]: docs.docker.com/engine/admin/logging/overview/ [5]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#log_driverString

The log driver to use for the container.

For tasks on 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][1

in the *Amazon Elastic Container

Service Developer Guide*.

For more information about using the `awsfirelens` log driver, see

Custom log routing][2

in the *Amazon Elastic Container Service

Developer Guide*.

<note markdown=“1”> If you have a custom driver that is not listed, 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, we do not currently provide support for running modified copies of this software.

</note>

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html [2]: docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html [3]: github.com/aws/amazon-ecs-agent

Returns:

  • (String)

6761
6762
6763
6764
6765
6766
6767
# File 'lib/aws-sdk-ecs/types.rb', line 6761

class LogConfiguration < Struct.new(
  :log_driver,
  :options,
  :secret_options)
  SENSITIVE = []
  include Aws::Structure
end

#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 'Aws::ECS::Types::LogConfiguration.{{.Server{.Server.APIVersion}'`

Returns:

  • (Hash<String,String>)

6761
6762
6763
6764
6765
6766
6767
# File 'lib/aws-sdk-ecs/types.rb', line 6761

class LogConfiguration < Struct.new(
  :log_driver,
  :options,
  :secret_options)
  SENSITIVE = []
  include Aws::Structure
end

#secret_optionsArray<Types::Secret>

The secrets to pass to the log configuration. For more information, see [Specifying Sensitive Data] in the *Amazon Elastic Container Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html

Returns:


6761
6762
6763
6764
6765
6766
6767
# File 'lib/aws-sdk-ecs/types.rb', line 6761

class LogConfiguration < Struct.new(
  :log_driver,
  :options,
  :secret_options)
  SENSITIVE = []
  include Aws::Structure
end