Package software.amazon.awssdk.services.batch.model

Interface LogConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<LogConfiguration.Builder,LogConfiguration>, SdkBuilder<LogConfiguration.Builder,LogConfiguration>, SdkPojo
Enclosing class:
LogConfiguration
public static interface LogConfiguration.Builder extends SdkPojo, CopyableBuilder<LogConfiguration.Builder,LogConfiguration>

  • Method Details

    • logDriver

      LogConfiguration.Builder logDriver(String logDriver)

      The log driver to use for the container. The valid values that are listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

      The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.

      Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.

      awslogs

      Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

      fluentd

      Specifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the Docker documentation.

      gelf

      Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and options, see Graylog Extended Format logging driver in the Docker documentation.

      journald

      Specifies the journald logging driver. For more information including usage and options, see Journald logging driver in the Docker documentation.

      json-file

      Specifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the Docker documentation.

      splunk

      Specifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the Docker documentation.

      syslog

      Specifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the Docker documentation.

      If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, 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 want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

      This parameter requires version 1.18 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 | grep "Server API version"

      Parameters:
      logDriver - The log driver to use for the container. The valid values that are listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

      The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.

      Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.

      awslogs

      Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

      fluentd

      Specifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the Docker documentation.

      gelf

      Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and options, see Graylog Extended Format logging driver in the Docker documentation.

      journald

      Specifies the journald logging driver. For more information including usage and options, see Journald logging driver in the Docker documentation.

      json-file

      Specifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the Docker documentation.

      splunk

      Specifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the Docker documentation.

      syslog

      Specifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the Docker documentation.

      If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, 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 want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

      This parameter requires version 1.18 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 | grep "Server API version"

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logDriver

      LogConfiguration.Builder logDriver(LogDriver logDriver)

      The log driver to use for the container. The valid values that are listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

      The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.

      Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.

      awslogs

      Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

      fluentd

      Specifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the Docker documentation.

      gelf

      Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and options, see Graylog Extended Format logging driver in the Docker documentation.

      journald

      Specifies the journald logging driver. For more information including usage and options, see Journald logging driver in the Docker documentation.

      json-file

      Specifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the Docker documentation.

      splunk

      Specifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the Docker documentation.

      syslog

      Specifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the Docker documentation.

      If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, 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 want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

      This parameter requires version 1.18 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 | grep "Server API version"

      Parameters:
      logDriver - The log driver to use for the container. The valid values that are listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

      The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.

      Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.

      awslogs

      Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

      fluentd

      Specifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the Docker documentation.

      gelf

      Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and options, see Graylog Extended Format logging driver in the Docker documentation.

      journald

      Specifies the journald logging driver. For more information including usage and options, see Journald logging driver in the Docker documentation.

      json-file

      Specifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the Docker documentation.

      splunk

      Specifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the Docker documentation.

      syslog

      Specifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the Docker documentation.

      If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, 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 want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

      This parameter requires version 1.18 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 | grep "Server API version"

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • options

      LogConfiguration.Builder options(Map<String,String> options)

      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 | grep "Server API version"

      Parameters:
      options - 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 | grep "Server API version"
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretOptions

      LogConfiguration.Builder secretOptions(Collection<Secret> secretOptions)

      The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Batch User Guide.

      Parameters:
      secretOptions - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Batch User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretOptions

      LogConfiguration.Builder secretOptions(Secret... secretOptions)

      The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Batch User Guide.

      Parameters:
      secretOptions - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Batch User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretOptions

      LogConfiguration.Builder secretOptions(Consumer<Secret.Builder>... secretOptions)

      The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Batch User Guide.

      This is a convenience method that creates an instance of the Secret.Builder avoiding the need to create one manually via Secret.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to secretOptions(List<Secret>).

      Parameters:
      secretOptions - a consumer that will call methods on Secret.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: