Package software.amazon.awscdk.services.batch

Interface CfnJobDefinition.LogConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobDefinition.LogConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnJobDefinition

@Stability(Stable)
public static interface CfnJobDefinition.LogConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Log configuration options to send to a custom log driver for the container.

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.batch.*;
 Object options;
 LogConfigurationProperty logConfigurationProperty = LogConfigurationProperty.builder()
         .logDriver("logDriver")
         // the properties below are optional
         .options(options)
         .secretOptions(List.of(SecretProperty.builder()
                 .name("name")
                 .valueFrom("valueFrom")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-logconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnJobDefinition.LogConfigurationProperty.Builder	builder()
String	getLogDriver()	The log driver to use for the container.
default Object	getOptions()	The configuration options to send to the log driver.
default Object	getSecretOptions()	The secrets to pass to the log configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLogDriver

@Stability(Stable)
@NotNull
String getLogDriver()

The log driver to use for the container.

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.

• awslogs - Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the AWS Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
• fluentd - Specifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the Docker documentation .
• gelf - Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and options, see Graylog Extended Format logging driver in the Docker documentation .
• journald - Specifies the journald logging driver. For more information including usage and options, see Journald logging driver in the Docker documentation .
• json-file - Specifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the Docker documentation .
• splunk - Specifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the Docker documentation .
• syslog - Specifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the Docker documentation .

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 available on GitHub 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"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-logconfiguration.html#cfn-batch-jobdefinition-logconfiguration-logdriver

getOptions

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

The configuration options to send to the log driver.

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"

See Also:

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

getSecretOptions

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

The secrets to pass to the log configuration.

For more information, see Specifying sensitive data in the AWS Batch User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-logconfiguration.html#cfn-batch-jobdefinition-logconfiguration-secretoptions

builder

@Stability(Stable)
static CfnJobDefinition.LogConfigurationProperty.Builder builder()

Returns:

a CfnJobDefinition.LogConfigurationProperty.Builder of CfnJobDefinition.LogConfigurationProperty