Package software.amazon.awscdk.services.ecs

Interface GenericLogDriverProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GenericLogDriverProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:06.599Z")
@Stability(Stable)
public interface GenericLogDriverProps
extends software.amazon.jsii.JsiiSerializable

The configuration to use when creating a log driver.

Example:

 // Create a Task Definition for the container to start
 Ec2TaskDefinition taskDefinition = new Ec2TaskDefinition(this, "TaskDef");
 taskDefinition.addContainer("TheContainer", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("example-image"))
         .memoryLimitMiB(256)
         .logging(GenericLogDriver.Builder.create()
                 .logDriver("fluentd")
                 .options(Map.of(
                         "tag", "example-tag"))
                 .build())
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GenericLogDriverProps.Builder	builder()
String	getLogDriver()	The log driver to use for the container.
default Map<String,String>	getOptions()	The configuration options to send to the log driver.
default Map<String,Secret>	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 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 and splunk. For tasks using the EC2 launch type, the supported log drivers are awslogs, syslog, gelf, fluentd, splunk, journald, and json-file.

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

getOptions

@Stability(Stable)
@Nullable
default Map<String,String> getOptions()

The configuration options to send to the log driver.

Default: - the log driver options.

getSecretOptions

@Stability(Stable)
@Nullable
default Map<String,Secret> getSecretOptions()

The secrets to pass to the log configuration.

Default: - no secret options provided.

builder

@Stability(Stable)
static GenericLogDriverProps.Builder builder()

Returns:

a GenericLogDriverProps.Builder of GenericLogDriverProps