Package software.amazon.awscdk.services.ecs

Interface BaseLogDriverProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

FireLensLogDriverProps, FluentdLogDriverProps, GelfLogDriverProps, JournaldLogDriverProps, JsonFileLogDriverProps, SplunkLogDriverProps, SyslogLogDriverProps

All Known Implementing Classes:

BaseLogDriverProps.Jsii$Proxy, FireLensLogDriverProps.Jsii$Proxy, FluentdLogDriverProps.Jsii$Proxy, GelfLogDriverProps.Jsii$Proxy, JournaldLogDriverProps.Jsii$Proxy, JsonFileLogDriverProps.Jsii$Proxy, SplunkLogDriverProps.Jsii$Proxy, SyslogLogDriverProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:14.405Z")
@Stability(Stable)
public interface BaseLogDriverProps
extends software.amazon.jsii.JsiiSerializable

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.*;
 BaseLogDriverProps baseLogDriverProps = BaseLogDriverProps.builder()
         .env(List.of("env"))
         .envRegex("envRegex")
         .labels(List.of("labels"))
         .tag("tag")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BaseLogDriverProps.Builder	builder()
default List<String>	getEnv()	The env option takes an array of keys.
default String	getEnvRegex()	The env-regex option is similar to and compatible with env.
default List<String>	getLabels()	The labels option takes an array of keys.
default String	getTag()	By default, Docker uses the first 12 characters of the container ID to tag log messages.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnv

@Stability(Stable)
@Nullable
default List<String> getEnv()

The env option takes an array of keys.

If there is collision between label and env keys, the value of the env takes precedence. Adds additional fields to the extra attributes of a logging message.

Default: - No env

getEnvRegex

@Stability(Stable)
@Nullable
default String getEnvRegex()

The env-regex option is similar to and compatible with env.

Its value is a regular expression to match logging-related environment variables. It is used for advanced log tag options.

Default: - No envRegex

getLabels

@Stability(Stable)
@Nullable
default List<String> getLabels()

The labels option takes an array of keys.

If there is collision between label and env keys, the value of the env takes precedence. Adds additional fields to the extra attributes of a logging message.

Default: - No labels

getTag

@Stability(Stable)
@Nullable
default String getTag()

By default, Docker uses the first 12 characters of the container ID to tag log messages.

Refer to the log tag option documentation for customizing the log tag format.

Default: - The first 12 characters of the container ID

builder

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

Returns:

a BaseLogDriverProps.Builder of BaseLogDriverProps