software.amazon.awscdk.services.batch

Interface LogConfiguration

All Known Implementing Classes:

LogConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:49.970Z")
public interface LogConfiguration

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

Example:

 import software.amazon.awscdk.services.ssm.*;
 JobDefinition.Builder.create(this, "job-def")
         .container(JobDefinitionContainer.builder()
                 .image(EcrImage.fromRegistry("docker/whalesay"))
                 .logConfiguration(LogConfiguration.builder()
                         .logDriver(LogDriver.AWSLOGS)
                         .options(Map.of("awslogs-region", "us-east-1"))
                         .secretOptions(List.of(ExposedSecret.fromParametersStore("xyz", StringParameter.fromStringParameterName(this, "parameter", "xyz"))))
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static LogConfiguration.Builder	builder()
LogDriver	getLogDriver() (experimental) The log driver to use for the container.
default java.lang.Object	getOptions() (experimental) The configuration options to send to the log driver.
default java.util.List<ExposedSecret>	getSecretOptions() (experimental) The secrets to pass to the log configuration as options.

Method Detail

getLogDriver

LogDriver getLogDriver()

(experimental) The log driver to use for the container.

getOptions

default java.lang.Object getOptions()

(experimental) The configuration options to send to the log driver.

Default: - No configuration options are sent

getSecretOptions

default java.util.List<ExposedSecret> getSecretOptions()

(experimental) The secrets to pass to the log configuration as options.

For more information, see https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data-secrets.html#secrets-logconfig

Default: - No secrets are passed

builder

static LogConfiguration.Builder builder()

Returns:

a LogConfiguration.Builder of LogConfiguration