Class CfnJobDefinition.LogConfigurationProperty
Log configuration options to send to a custom log driver for the container.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class LogConfigurationProperty : Object, CfnJobDefinition.ILogConfigurationProperty
Syntax (vb)
Public Class LogConfigurationProperty
Inherits Object
Implements CfnJobDefinition.ILogConfigurationProperty
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.Batch;
var options;
var logConfigurationProperty = new LogConfigurationProperty {
LogDriver = "logDriver",
// the properties below are optional
Options = 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
The valid values that are listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
The supported log drivers are awslogs
, fluentd
, gelf
, json-file
, journald
, logentries
, syslog
, and splunk
.
Jobs that are running on Fargate resources are restricted to the awslogs
and splunk
log drivers.
If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's <a href="https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent">available on GitHub</a> and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.
This parameter requires version 1.18 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 | grep "Server API version"
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 | grep "Server API version"
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 AWS Batch User Guide .