software.amazon.awscdk.services.ecs

Interface CfnTaskDefinition.LogConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTaskDefinition.LogConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnTaskDefinition

@Stability(value=Stable)
public static interface CfnTaskDefinition.LogConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The `LogConfiguration` property specifies log configuration options to send to a custom log driver for the container.

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.*;
 LogConfigurationProperty logConfigurationProperty = LogConfigurationProperty.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	CfnTaskDefinition.LogConfigurationProperty.Builder A builder for CfnTaskDefinition.LogConfigurationProperty
static class	CfnTaskDefinition.LogConfigurationProperty.Jsii$Proxy An implementation for CfnTaskDefinition.LogConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnTaskDefinition.LogConfigurationProperty.Builder	builder()
String	getLogDriver() The log driver to use for the container.
default Object	getOptions() The configuration options to send to the log driver.
default Object	getSecretOptions() The secrets to pass to the log configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getLogDriver

@Stability(value=Stable)
 @NotNull
String getLogDriver()

The log driver to use for the container.

For tasks on AWS Fargate , the supported log drivers are awslogs , splunk , and awsfirelens .

For tasks hosted on Amazon EC2 instances, 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 .

If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.

getOptions

@Stability(value=Stable)
 @Nullable
default Object getOptions()

The configuration options to send to the log driver.

This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

getSecretOptions

@Stability(value=Stable)
 @Nullable
default Object getSecretOptions()

The secrets to pass to the log configuration.

For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide .

builder

@Stability(value=Stable)
static CfnTaskDefinition.LogConfigurationProperty.Builder builder()

Returns:

a CfnTaskDefinition.LogConfigurationProperty.Builder of CfnTaskDefinition.LogConfigurationProperty