Class: AWSCDK::Batch::CfnJobDefinition::FirelensConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Batch::CfnJobDefinition::FirelensConfigurationProperty

Defined in:

batch/cfn_job_definition.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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-firelensconfiguration.html

Instance Attribute Summary

• #options ⇒ AWSCDK::IResolvable, ... readonly

  The options to use when configuring the log router.

• #type ⇒ String readonly

  The log router to use.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(type:, options: nil) ⇒ FirelensConfigurationProperty constructor

  A new instance of FirelensConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(type:, options: nil) ⇒ FirelensConfigurationProperty

Returns a new instance of FirelensConfigurationProperty.

Parameters:

• type (String) —

  The log router to use.

• options (AWSCDK::IResolvable, Hash{String => String}, nil) (defaults to: nil) —

  The options to use when configuring the log router.

# File 'batch/cfn_job_definition.rb', line 2153

def initialize(type:, options: nil)
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @options = options
  Jsii::Type.check_type(@options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "options") unless @options.nil?
end

Instance Attribute Details

#options ⇒ AWSCDK::IResolvable, ... (readonly)

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":{"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 .

Returns:

• (AWSCDK::IResolvable, Hash{String => String}, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-firelensconfiguration.html#cfn-batch-jobdefinition-firelensconfiguration-options

# File 'batch/cfn_job_definition.rb', line 2173

def options
  @options
end

#type ⇒ String (readonly)

The log router to use.

The valid values are fluentd or fluentbit .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-firelensconfiguration.html#cfn-batch-jobdefinition-firelensconfiguration-type

# File 'batch/cfn_job_definition.rb', line 2166

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object

# File 'batch/cfn_job_definition.rb', line 2175

def self.jsii_properties
  {
    :type => "type",
    :options => "options",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'batch/cfn_job_definition.rb', line 2182

def to_jsii
  result = {}
  result.merge!({
    "type" => @type,
    "options" => @options,
  })
  result.compact
end