Package software.amazon.awscdk.services.ecs

Interface CfnTaskDefinition.FirelensConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTaskDefinition.FirelensConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnTaskDefinition

@Stability(Stable)
public static interface CfnTaskDefinition.FirelensConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 FirelensConfigurationProperty firelensConfigurationProperty = FirelensConfigurationProperty.builder()
         .options(Map.of(
                 "optionsKey", "options"))
         .type("type")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTaskDefinition.FirelensConfigurationProperty.Builder	A builder for CfnTaskDefinition.FirelensConfigurationProperty
static final class	CfnTaskDefinition.FirelensConfigurationProperty.Jsii$Proxy	An implementation for CfnTaskDefinition.FirelensConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnTaskDefinition.FirelensConfigurationProperty.Builder	builder()
default Object	getOptions()	The options to use when configuring the log router.
default String	getType()	The log router to use.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOptions

@Stability(Stable)
@Nullable
default Object getOptions()

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

See Also:

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

getType

@Stability(Stable)
@Nullable
default String getType()

The log router to use.

The valid values are fluentd or fluentbit .

See Also:

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

builder

@Stability(Stable)
static CfnTaskDefinition.FirelensConfigurationProperty.Builder builder()

Returns:

a CfnTaskDefinition.FirelensConfigurationProperty.Builder of CfnTaskDefinition.FirelensConfigurationProperty