software.amazon.awscdk.services.ecs

Interface LogDriverConfig

All Known Implementing Classes:

LogDriverConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:10.718Z")
public interface LogDriverConfig

The configuration to use when creating a log driver.

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.ecs.*;
 LogDriverConfig logDriverConfig = LogDriverConfig.builder()
         .logDriver("logDriver")
         // the properties below are optional
         .options(Map.of(
                 "optionsKey", "options"))
         .secretOptions(List.of(SecretProperty.builder()
                 .name("name")
                 .valueFrom("valueFrom")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static LogDriverConfig.Builder	builder()
java.lang.String	getLogDriver() The log driver to use for the container.
default java.util.Map<java.lang.String,java.lang.String>	getOptions() The configuration options to send to the log driver.
default java.util.List<CfnTaskDefinition.SecretProperty>	getSecretOptions() The secrets to pass to the log configuration.

Method Detail

getLogDriver

java.lang.String getLogDriver()

The log driver to use for the container.

The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

For tasks using the Fargate launch type, the supported log drivers are awslogs, splunk, and awsfirelens. For tasks using the EC2 launch type, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.

For more information about using the awslogs log driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.

For more information about using the awsfirelens log driver, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

getOptions

default java.util.Map<java.lang.String,java.lang.String> getOptions()

The configuration options to send to the log driver.

getSecretOptions

default java.util.List<CfnTaskDefinition.SecretProperty> getSecretOptions()

The secrets to pass to the log configuration.

Default: - No secret options provided.

builder

static LogDriverConfig.Builder builder()

Returns:

a LogDriverConfig.Builder of LogDriverConfig