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

Description

Documentation

data ExecuteCommandConfiguration Source #

The details of the execute command configuration.

See: newExecuteCommandConfiguration smart constructor.

Constructors

ExecuteCommandConfiguration'

Fields

logConfiguration :: Maybe ExecuteCommandLogConfiguration
The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.
kmsKeyId :: Maybe Text
Specify an Key Management Service key ID to encrypt the data between the local client and the container.
logging :: Maybe ExecuteCommandLogging
The log setting to use for redirecting logs for your execute command results. The following log settings are available.
- NONE: The execute command session is not logged.
- DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.
- OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.

Instances

Instances details

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

newExecuteCommandConfiguration :: ExecuteCommandConfiguration Source #

Create a value of ExecuteCommandConfiguration 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:logConfiguration:ExecuteCommandConfiguration', executeCommandConfiguration_logConfiguration - The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.

$sel:kmsKeyId:ExecuteCommandConfiguration', executeCommandConfiguration_kmsKeyId - Specify an Key Management Service key ID to encrypt the data between the local client and the container.

$sel:logging:ExecuteCommandConfiguration', executeCommandConfiguration_logging - The log setting to use for redirecting logs for your execute command results. The following log settings are available.

NONE: The execute command session is not logged.
DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.
OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.

executeCommandConfiguration_logConfiguration :: Lens' ExecuteCommandConfiguration (Maybe ExecuteCommandLogConfiguration) Source #

The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.

executeCommandConfiguration_kmsKeyId :: Lens' ExecuteCommandConfiguration (Maybe Text) Source #

Specify an Key Management Service key ID to encrypt the data between the local client and the container.

executeCommandConfiguration_logging :: Lens' ExecuteCommandConfiguration (Maybe ExecuteCommandLogging) Source #

The log setting to use for redirecting logs for your execute command results. The following log settings are available.

NONE: The execute command session is not logged.
DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.
OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.