Show / Hide Table of Contents

Class CfnJobDefinition.FirelensConfigurationProperty

The FireLens configuration for the container.

Inheritance
object
CfnJobDefinition.FirelensConfigurationProperty
Implements
CfnJobDefinition.IFirelensConfigurationProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnJobDefinition.FirelensConfigurationProperty : CfnJobDefinition.IFirelensConfigurationProperty
Syntax (vb)
Public Class CfnJobDefinition.FirelensConfigurationProperty Implements CfnJobDefinition.IFirelensConfigurationProperty
Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-firelensconfiguration.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Batch;

             var firelensConfigurationProperty = new FirelensConfigurationProperty {
                 Type = "type",

                 // the properties below are optional
                 Options = new Dictionary<string, string> {
                     { "optionsKey", "options" }
                 }
             };

Synopsis

Constructors

FirelensConfigurationProperty()

The FireLens configuration for the container.

Properties

Options

The options to use when configuring the log router.

Type

The log router to use.

Constructors

FirelensConfigurationProperty()

The FireLens configuration for the container.

public FirelensConfigurationProperty()
Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-firelensconfiguration.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Batch;

             var firelensConfigurationProperty = new FirelensConfigurationProperty {
                 Type = "type",

                 // the properties below are optional
                 Options = new Dictionary<string, string> {
                     { "optionsKey", "options" }
                 }
             };

Properties

Options

The options to use when configuring the log router.

public object? Options { get; set; }
Property Value

object

Remarks

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 .

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

Type union: either Dictionary<string, string> or IResolvable

Type

The log router to use.

public string Type { get; set; }
Property Value

string

Remarks

The valid values are fluentd or fluentbit .

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

Implements

CfnJobDefinition.IFirelensConfigurationProperty
Back to top Generated by DocFX