Class LogDriverConfig

The configuration to use when creating a log driver.

Inheritance

object

LogDriverConfig

Implements

ILogDriverConfig

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.ECS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class LogDriverConfig : ILogDriverConfig

Syntax (vb)

Public Class LogDriverConfig Implements ILogDriverConfig

Remarks

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.ECS;

            var logDriverConfig = new LogDriverConfig {
                LogDriver = "logDriver",

                // the properties below are optional
                Options = new Dictionary<string, string> {
                    { "optionsKey", "options" }
                },
                SecretOptions = new [] { new SecretProperty {
                    Name = "name",
                    ValueFrom = "valueFrom"
                } }
            };

Synopsis

Constructors

LogDriverConfig()

The configuration to use when creating a log driver.

Properties

LogDriver	The log driver to use for the container.
Options	The configuration options to send to the log driver.
SecretOptions	The secrets to pass to the log configuration.

Constructors

LogDriverConfig()

The configuration to use when creating a log driver.

public LogDriverConfig()

Remarks

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.ECS;

            var logDriverConfig = new LogDriverConfig {
                LogDriver = "logDriver",

                // the properties below are optional
                Options = new Dictionary<string, string> {
                    { "optionsKey", "options" }
                },
                SecretOptions = new [] { new SecretProperty {
                    Name = "name",
                    ValueFrom = "valueFrom"
                } }
            };

Properties

LogDriver

The log driver to use for the container.

public string LogDriver { get; set; }

Property Value

string

Remarks

The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

For tasks using the Fargate launch type, the supported log drivers are awslogs, splunk, and awsfirelens. For tasks using the EC2 launch type, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

For more information about using the awslogs log driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.

For more information about using the awsfirelens log driver, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

Options

The configuration options to send to the log driver.

public IDictionary<string, string>? Options { get; set; }

Property Value

IDictionary<string, string>

Remarks

ExampleMetadata: fixture=_generated

SecretOptions

The secrets to pass to the log configuration.

public CfnTaskDefinition.ISecretProperty[]? SecretOptions { get; set; }

Property Value

ISecretProperty[]

Remarks

Default: - No secret options provided.

Implements

ILogDriverConfig