Interface FirelensOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
FirelensOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-22T22:42:51.155Z") @Stability(Stable) public interface FirelensOptions extends software.amazon.jsii.JsiiSerializable
The options for firelens log router https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef-customconfig.

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.*;
 FirelensOptions firelensOptions = FirelensOptions.builder()
         .configFileType(FirelensConfigFileType.S3)
         .configFileValue("configFileValue")
         .enableECSLogMetadata(false)
         .build();
 
  • Method Details

    • getConfigFileType

      @Stability(Stable) @Nullable default FirelensConfigFileType getConfigFileType()
      Custom configuration file, s3 or file.

      Both configFileType and configFileValue must be used together to define a custom configuration source.

      Default: - determined by checking configFileValue with S3 ARN.

    • getConfigFileValue

      @Stability(Stable) @Nullable default String getConfigFileValue()
      Custom configuration file, S3 ARN or a file path Both configFileType and configFileValue must be used together to define a custom configuration source.

      Default: - no config file value

    • getEnableECSLogMetadata

      @Stability(Stable) @Nullable default Boolean getEnableECSLogMetadata()
      By default, Amazon ECS adds additional fields in your log entries that help identify the source of the logs.

      You can disable this action by setting enable-ecs-log-metadata to false.

      Default: - true

    • builder

      @Stability(Stable) static FirelensOptions.Builder builder()
      Returns:
      a FirelensOptions.Builder of FirelensOptions