Class CfnService.LogConfigurationProperty

The log configuration for the container.

Inheritance

System.Object

CfnService.LogConfigurationProperty

Implements

CfnService.ILogConfigurationProperty

Namespace: Amazon.CDK.AWS.ECS

Assembly: Amazon.CDK.AWS.ECS.dll

Syntax (csharp)

public class LogConfigurationProperty : Object, CfnService.ILogConfigurationProperty

Syntax (vb)

Public Class LogConfigurationProperty
    Inherits Object
    Implements CfnService.ILogConfigurationProperty

Remarks

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run .

By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Understand the following when specifying a log configuration for your containers.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-logconfiguration.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.ECS;

var logConfigurationProperty = new LogConfigurationProperty {
    LogDriver = "logDriver",
    Options = new Dictionary<string, string> {
        { "optionsKey", "options" }
    },
    SecretOptions = new [] { new SecretProperty {
        Name = "name",
        ValueFrom = "valueFrom"
    } }
};

Synopsis

Constructors

LogConfigurationProperty()

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

LogConfigurationProperty()

public LogConfigurationProperty()

Properties

LogDriver

The log driver to use for the container.

public string LogDriver { get; set; }

Property Value

System.String

Remarks

For tasks on AWS Fargate , the supported log drivers are awslogs , splunk , and awsfirelens .

For tasks hosted on Amazon EC2 instances, 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 .

If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-logconfiguration.html#cfn-ecs-service-logconfiguration-logdriver

Options

The configuration options to send to the log driver.

public object Options { get; set; }

Property Value

System.Object

Remarks

This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-logconfiguration.html#cfn-ecs-service-logconfiguration-options

SecretOptions

The secrets to pass to the log configuration.

public object SecretOptions { get; set; }

Property Value

System.Object

Remarks

For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-logconfiguration.html#cfn-ecs-service-logconfiguration-secretoptions

Implements

CfnService.ILogConfigurationProperty