Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Batch.Types.LogConfiguration

Description

Synopsis

Documentation

data LogConfiguration Source #

Log configuration options to send to a custom log driver for the container.

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 into your container instance and run the following command: sudo docker version | grep "Server API version"
secretOptions :: Maybe [Secret]
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Batch User Guide.
logDriver :: LogDriver
The log driver to use for the container. The valid values 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 into your container instance and run the following command: sudo docker version | grep "Server API version"

Instances

Instances details

Eq LogConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.LogConfiguration Methods (==) :: LogConfiguration -> LogConfiguration -> Bool # (/=) :: LogConfiguration -> LogConfiguration -> Bool #
Read LogConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.LogConfiguration Methods readsPrec :: Int -> ReadS LogConfiguration # readList :: ReadS [LogConfiguration] # readPrec :: ReadPrec LogConfiguration # readListPrec :: ReadPrec [LogConfiguration] #
Show LogConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.LogConfiguration Methods showsPrec :: Int -> LogConfiguration -> ShowS # show :: LogConfiguration -> String # showList :: [LogConfiguration] -> ShowS #
Generic LogConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.LogConfiguration Associated Types type Rep LogConfiguration :: Type -> Type # Methods from :: LogConfiguration -> Rep LogConfiguration x # to :: Rep LogConfiguration x -> LogConfiguration #
NFData LogConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.LogConfiguration Methods rnf :: LogConfiguration -> () #
Hashable LogConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.LogConfiguration Methods hashWithSalt :: Int -> LogConfiguration -> Int # hash :: LogConfiguration -> Int #
ToJSON LogConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.LogConfiguration Methods toJSON :: LogConfiguration -> Value # toEncoding :: LogConfiguration -> Encoding # toJSONList :: [LogConfiguration] -> Value # toEncodingList :: [LogConfiguration] -> Encoding #
FromJSON LogConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.LogConfiguration Methods parseJSON :: Value -> Parser LogConfiguration # parseJSONList :: Value -> Parser [LogConfiguration] #
type Rep LogConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.LogConfiguration type Rep LogConfiguration = D1 ('MetaData "LogConfiguration" "Amazonka.Batch.Types.LogConfiguration" "libZSservicesZSamazonka-batchZSamazonka-batch" '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 Source #

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 into your container instance and run the following command: sudo docker version | grep "Server API version"

$sel:secretOptions:LogConfiguration', logConfiguration_secretOptions - The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Batch User Guide.

$sel:logDriver:LogConfiguration', logConfiguration_logDriver - The log driver to use for the container. The valid values 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 into your container instance and run the following command: sudo docker version | grep "Server API version"

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

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 into your container instance and run the following command: sudo docker version | grep "Server API version"

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

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

logConfiguration_logDriver :: Lens' LogConfiguration LogDriver Source #

The log driver to use for the container. The valid values 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 into your container instance and run the following command: sudo docker version | grep "Server API version"