Class: AWSCDK::ECS::CfnTaskDefinition::FirelensConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::ECS::CfnTaskDefinition::FirelensConfigurationProperty

Defined in:

ecs/cfn_task_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-ecs-taskdefinition-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(options: nil, type: nil) ⇒ FirelensConfigurationProperty constructor

  A new instance of FirelensConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

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

Returns a new instance of FirelensConfigurationProperty.

Parameters:

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

  The options to use when configuring the log router.

• type (String, nil) (defaults to: nil) —

  The log router to use.

# File 'ecs/cfn_task_definition.rb', line 1957

def initialize(options: nil, type: nil)
  @options = options
  Jsii::Type.check_type(@options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "options") unless @options.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.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 add additional metadata, such as the task, task definition, cluster, and container instance details to the log event.

If specified, valid option keys are:

• enable-ecs-log-metadata , which can be true or false
• config-file-type , which can be s3 or file
• config-file-value , which is either an S3 ARN or a file path

Returns:

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

See Also:

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

# File 'ecs/cfn_task_definition.rb', line 1976

def options
  @options
end

#type ⇒ String^? (readonly)

The log router to use.

The valid values are fluentd or fluentbit .

Returns:

• (String, nil)

See Also:

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

# File 'ecs/cfn_task_definition.rb', line 1983

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object

# File 'ecs/cfn_task_definition.rb', line 1985

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

Instance Method Details

#to_jsii ⇒ Object

# File 'ecs/cfn_task_definition.rb', line 1992

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