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.ECS.Types.FirelensConfiguration

Description

Documentation

data FirelensConfiguration Source #

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

See: newFirelensConfiguration smart constructor.

Constructors

FirelensConfiguration'

Fields

options :: Maybe (HashMap Text Text)
The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.
Tasks hosted on Fargate only support the file configuration file type.
type' :: FirelensConfigurationType
The log router to use. The valid values are fluentd or fluentbit.

Instances

Instances details

Eq FirelensConfiguration Source #
Instance details Defined in Amazonka.ECS.Types.FirelensConfiguration Methods (==) :: FirelensConfiguration -> FirelensConfiguration -> Bool # (/=) :: FirelensConfiguration -> FirelensConfiguration -> Bool #
Read FirelensConfiguration Source #
Instance details Defined in Amazonka.ECS.Types.FirelensConfiguration Methods readsPrec :: Int -> ReadS FirelensConfiguration # readList :: ReadS [FirelensConfiguration] # readPrec :: ReadPrec FirelensConfiguration # readListPrec :: ReadPrec [FirelensConfiguration] #
Show FirelensConfiguration Source #
Instance details Defined in Amazonka.ECS.Types.FirelensConfiguration Methods showsPrec :: Int -> FirelensConfiguration -> ShowS # show :: FirelensConfiguration -> String # showList :: [FirelensConfiguration] -> ShowS #
Generic FirelensConfiguration Source #
Instance details Defined in Amazonka.ECS.Types.FirelensConfiguration Associated Types type Rep FirelensConfiguration :: Type -> Type # Methods from :: FirelensConfiguration -> Rep FirelensConfiguration x # to :: Rep FirelensConfiguration x -> FirelensConfiguration #
NFData FirelensConfiguration Source #
Instance details Defined in Amazonka.ECS.Types.FirelensConfiguration Methods rnf :: FirelensConfiguration -> () #
Hashable FirelensConfiguration Source #
Instance details Defined in Amazonka.ECS.Types.FirelensConfiguration Methods hashWithSalt :: Int -> FirelensConfiguration -> Int # hash :: FirelensConfiguration -> Int #
ToJSON FirelensConfiguration Source #
Instance details Defined in Amazonka.ECS.Types.FirelensConfiguration Methods toJSON :: FirelensConfiguration -> Value # toEncoding :: FirelensConfiguration -> Encoding # toJSONList :: [FirelensConfiguration] -> Value # toEncodingList :: [FirelensConfiguration] -> Encoding #
FromJSON FirelensConfiguration Source #
Instance details Defined in Amazonka.ECS.Types.FirelensConfiguration Methods parseJSON :: Value -> Parser FirelensConfiguration # parseJSONList :: Value -> Parser [FirelensConfiguration] #
type Rep FirelensConfiguration Source #
Instance details Defined in Amazonka.ECS.Types.FirelensConfiguration type Rep FirelensConfiguration = D1 ('MetaData "FirelensConfiguration" "Amazonka.ECS.Types.FirelensConfiguration" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "FirelensConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FirelensConfigurationType)))

newFirelensConfiguration Source #

Arguments

:: FirelensConfigurationType	`$sel:type':FirelensConfiguration'`
-> FirelensConfiguration

Create a value of FirelensConfiguration 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:FirelensConfiguration', firelensConfiguration_options - The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

$sel:type':FirelensConfiguration', firelensConfiguration_type - The log router to use. The valid values are fluentd or fluentbit.

firelensConfiguration_options :: Lens' FirelensConfiguration (Maybe (HashMap Text Text)) Source #

The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.

Tasks hosted on Fargate only support the file configuration file type.

firelensConfiguration_type :: Lens' FirelensConfiguration FirelensConfigurationType Source #

The log router to use. The valid values are fluentd or fluentbit.