Package software.amazon.awscdk.services.ecs

Interface CfnService.LogConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnService.LogConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnService
@Stability(Stable) public static interface CfnService.LogConfigurationProperty extends software.amazon.jsii.JsiiSerializable
The log configuration for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run .

By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Understand the following when specifying a log configuration for your containers.

  • Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the valid values below). Additional log drivers may be available in future releases of the Amazon ECS container agent.
  • This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
  • For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide .
  • For tasks that are on AWS Fargate , because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.

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")
         .options(Map.of(
                 "optionsKey", "options"))
         .secretOptions(List.of(SecretProperty.builder()
                 .name("name")
                 .valueFrom("valueFrom")
                 .build()))
         .build();

  • Method Details

    • getLogDriver

      @Stability(Stable) @Nullable default 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(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(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(Stable) static CfnService.LogConfigurationProperty.Builder builder()
      Returns:
      a CfnService.LogConfigurationProperty.Builder of CfnService.LogConfigurationProperty