Class: Aws::Batch::Types::LogConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-batch/lib/aws-sdk-batch/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
  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.

Constant Summary collapse

SENSITIVE =
[]

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.

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

Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.

awslogs

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

fluentd

Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver 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 in the Docker documentation.

journald

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

json-file

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

splunk

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

syslog

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

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 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.

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"

Returns:

  • (String)


3743
3744
3745
3746
3747
3748
3749
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3743

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 into your container instance and run the following command: sudo docker version | grep "Server API version"

Returns:

  • (Hash<String,String>)


3743
3744
3745
3746
3747
3748
3749
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3743

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 Batch User Guide.

Returns:



3743
3744
3745
3746
3747
3748
3749
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3743

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