Package software.amazon.awscdk.services.batch

Class CfnJobDefinition.LogConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.batch.CfnJobDefinition.LogConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnJobDefinition.LogConfigurationProperty>

Enclosing interface:

CfnJobDefinition.LogConfigurationProperty

@Stability(Stable)
public static final class CfnJobDefinition.LogConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnJobDefinition.LogConfigurationProperty>

A builder for CfnJobDefinition.LogConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnJobDefinition.LogConfigurationProperty	build()	Builds the configured instance.
CfnJobDefinition.LogConfigurationProperty.Builder	logDriver(String logDriver)	Sets the value of CfnJobDefinition.LogConfigurationProperty.getLogDriver()
CfnJobDefinition.LogConfigurationProperty.Builder	options(Object options)	Sets the value of CfnJobDefinition.LogConfigurationProperty.getOptions()
CfnJobDefinition.LogConfigurationProperty.Builder	secretOptions(List<? extends Object> secretOptions)	Sets the value of CfnJobDefinition.LogConfigurationProperty.getSecretOptions()
CfnJobDefinition.LogConfigurationProperty.Builder	secretOptions(IResolvable secretOptions)	Sets the value of CfnJobDefinition.LogConfigurationProperty.getSecretOptions()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

logDriver

@Stability(Stable)
public CfnJobDefinition.LogConfigurationProperty.Builder logDriver(String logDriver)

Sets the value of CfnJobDefinition.LogConfigurationProperty.getLogDriver()

Parameters:

logDriver - The log driver to use for the container. This parameter is required. 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"

Returns:

this

options

@Stability(Stable)
public CfnJobDefinition.LogConfigurationProperty.Builder options(Object options)

Sets the value of CfnJobDefinition.LogConfigurationProperty.getOptions()

Parameters:

options - 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"

Returns:

this

secretOptions

@Stability(Stable)
public CfnJobDefinition.LogConfigurationProperty.Builder secretOptions(IResolvable secretOptions)

Sets the value of CfnJobDefinition.LogConfigurationProperty.getSecretOptions()

Parameters:

secretOptions - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the AWS Batch User Guide .

Returns:

this

secretOptions

@Stability(Stable)
public CfnJobDefinition.LogConfigurationProperty.Builder secretOptions(List<? extends Object> secretOptions)

Sets the value of CfnJobDefinition.LogConfigurationProperty.getSecretOptions()

Parameters:

secretOptions - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the AWS Batch User Guide .

Returns:

this

build

@Stability(Stable)
public CfnJobDefinition.LogConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnJobDefinition.LogConfigurationProperty>

Returns:

a new instance of CfnJobDefinition.LogConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided