Amazonka.ECS.Types.LogConfiguration

Documentation

data LogConfiguration

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 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.

See: newLogConfiguration smart constructor.

Constructors

LogConfiguration'

Fields

• options :: Maybe (HashMap Text Text)

  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}}'

• secretOptions :: Maybe [Secret]

  The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

• logDriver :: LogDriver

  The log driver to use for the container.

  For tasks on 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.

Instances

FromJSON LogConfiguration

Defined in Amazonka.ECS.Types.LogConfiguration

Methods

parseJSON :: Value -> Parser LogConfiguration

parseJSONList :: Value -> Parser [LogConfiguration]

ToJSON LogConfiguration

Defined in Amazonka.ECS.Types.LogConfiguration

Methods

toJSON :: LogConfiguration -> Value

toEncoding :: LogConfiguration -> Encoding

toJSONList :: [LogConfiguration] -> Value

toEncodingList :: [LogConfiguration] -> Encoding

Generic LogConfiguration

Defined in Amazonka.ECS.Types.LogConfiguration

Associated Types

type Rep LogConfiguration :: Type -> Type

Methods

from :: LogConfiguration -> Rep LogConfiguration x

to :: Rep LogConfiguration x -> LogConfiguration

Read LogConfiguration

Defined in Amazonka.ECS.Types.LogConfiguration

Methods

readsPrec :: Int -> ReadS LogConfiguration

readList :: ReadS [LogConfiguration]

readPrec :: ReadPrec LogConfiguration

readListPrec :: ReadPrec [LogConfiguration]

Show LogConfiguration

Defined in Amazonka.ECS.Types.LogConfiguration

Methods

showsPrec :: Int -> LogConfiguration -> ShowS

show :: LogConfiguration -> String

showList :: [LogConfiguration] -> ShowS

NFData LogConfiguration

Defined in Amazonka.ECS.Types.LogConfiguration

Methods

rnf :: LogConfiguration -> ()

Eq LogConfiguration

Defined in Amazonka.ECS.Types.LogConfiguration

Methods

(==) :: LogConfiguration -> LogConfiguration -> Bool

(/=) :: LogConfiguration -> LogConfiguration -> Bool

Hashable LogConfiguration

Defined in Amazonka.ECS.Types.LogConfiguration

Methods

hashWithSalt :: Int -> LogConfiguration -> Int

hash :: LogConfiguration -> Int

type Rep LogConfiguration

Defined in Amazonka.ECS.Types.LogConfiguration

type Rep LogConfiguration = D1 ('MetaData "LogConfiguration" "Amazonka.ECS.Types.LogConfiguration" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "LogConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "secretOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Secret])) :*: S1 ('MetaSel ('Just "logDriver") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LogDriver))))

newLogConfiguration

Arguments

:: LogDriver

$sel:logDriver:LogConfiguration'

-> LogConfiguration

Create a value of LogConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:options:LogConfiguration', logConfiguration_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 --format '{{.Server.APIVersion}}'

$sel:secretOptions:LogConfiguration', logConfiguration_secretOptions - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

$sel:logDriver:LogConfiguration', logConfiguration_logDriver - The log driver to use for the container.

For tasks on 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.

logConfiguration_options :: Lens' LogConfiguration (Maybe (HashMap Text Text))

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}}'

logConfiguration_secretOptions :: Lens' LogConfiguration (Maybe [Secret])

The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.

logConfiguration_logDriver :: Lens' LogConfiguration LogDriver

The log driver to use for the container.

For tasks on 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.