Class: Aws::Batch::Types::FirelensConfiguration

Inherits:

Struct

Object
Struct
Aws::Batch::Types::FirelensConfiguration

show all

Includes:: Structure

Defined in:: lib/aws-sdk-batch/types.rb

Overview

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom log] routing in the *Amazon Elastic Container Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#options ⇒ Hash<String,String>

The options to use when configuring the log router.
#type ⇒ String

The log router to use.

Instance Attribute Details

#options ⇒ `Hash<String,String>`

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is ‘“options”:Aws::Batch::Types::FirelensConfiguration.“enable-ecs-log-metadata”:“true|false”,“config-file-type:”s3|file“,”config-file-value“:”arn:aws:s3:“enable-ecs-log-metadata”:“true|false”,“config-file-type:”s3|file“,”config-file-value“:”arn:aws:s3:::mybucket/fluent“enable-ecs-log-metadata”:“true|false”,“config-file-type:”s3|file“,”config-file-value“:”arn:aws:s3:::mybucket/fluent.conf|filepath“`. For more information, see [Creating a task definition that uses a FireLens configuration] in the *Amazon Elastic Container Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-batch/types.rb', line 5042

class FirelensConfiguration < Struct.new(
  :type,
  :options)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ `String`

The log router to use. The valid values are ‘fluentd` or `fluentbit`.