Package software.amazon.awscdk.services.ecs

Interface GelfLogDriverProps

All Superinterfaces:

BaseLogDriverProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GelfLogDriverProps.Jsii$Proxy

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

Specifies the journald log driver configuration options.

Source

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(LogDrivers.gelf(GelfLogDriverProps.builder().address("my-gelf-address").build()))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GelfLogDriverProps.Builder	builder()
String	getAddress()	The address of the GELF server.
default Number	getCompressionLevel()	UDP Only The level of compression when gzip or zlib is the gelf-compression-type.
default GelfCompressionType	getCompressionType()	UDP Only The type of compression the GELF driver uses to compress each log message.
default Number	getTcpMaxReconnect()	TCP Only The maximum number of reconnection attempts when the connection drop.
default Duration	getTcpReconnectDelay()	TCP Only The number of seconds to wait between reconnection attempts.

Methods inherited from interface software.amazon.awscdk.services.ecs.BaseLogDriverProps

getEnv, getEnvRegex, getLabels, getTag

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAddress

@Stability(Stable)
@NotNull
String getAddress()

The address of the GELF server.

tcp and udp are the only supported URI specifier and you must specify the port.

getCompressionLevel

@Stability(Stable)
@Nullable
default Number getCompressionLevel()

UDP Only The level of compression when gzip or zlib is the gelf-compression-type.

An integer in the range of -1 to 9 (BestCompression). Higher levels provide more compression at lower speed. Either -1 or 0 disables compression.

Default: - 1

getCompressionType

@Stability(Stable)
@Nullable
default GelfCompressionType getCompressionType()

UDP Only The type of compression the GELF driver uses to compress each log message.

Allowed values are gzip, zlib and none.

Default: - gzip

getTcpMaxReconnect

@Stability(Stable)
@Nullable
default Number getTcpMaxReconnect()

TCP Only The maximum number of reconnection attempts when the connection drop.

A positive integer.

Default: - 3

getTcpReconnectDelay

@Stability(Stable)
@Nullable
default Duration getTcpReconnectDelay()

TCP Only The number of seconds to wait between reconnection attempts.

A positive integer.

Default: - 1

builder

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

Returns:

a GelfLogDriverProps.Builder of GelfLogDriverProps