Package software.amazon.awscdk.services.batch

Interface LogConfiguration

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LogConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.670Z")
@Stability(Experimental)
public interface LogConfiguration
extends software.amazon.jsii.JsiiSerializable

(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	Description
static final class	LogConfiguration.Builder	A builder for LogConfiguration
static final class	LogConfiguration.Jsii$Proxy	An implementation for LogConfiguration

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLogDriver

@Stability(Experimental)
@NotNull
LogDriver getLogDriver()

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

getOptions

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

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

Default: - No configuration options are sent

getSecretOptions

@Stability(Experimental)
@Nullable
default 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

@Stability(Experimental)
static LogConfiguration.Builder builder()

Returns:

a LogConfiguration.Builder of LogConfiguration