Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ECS.Types.DeploymentAlarms

Description

Synopsis

Documentation

data DeploymentAlarms Source #

One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.

When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure.

You can only use the DeploymentAlarms method to detect failures when the DeploymentController is set to ECS (rolling update).

For more information, see Rolling update in the /Amazon Elastic Container Service Developer Guide/ .

See: newDeploymentAlarms smart constructor.

Constructors

DeploymentAlarms'

Fields

alarmNames :: [Text]
One or more CloudWatch alarm names. Use a "," to separate the alarms.
enable :: Bool
Determines whether to use the CloudWatch alarm option in the service deployment process.
rollback :: Bool
Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

Instances

Instances details

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

newDeploymentAlarms Source #

Arguments

:: Bool	`$sel:enable:DeploymentAlarms'`
-> Bool	`$sel:rollback:DeploymentAlarms'`
-> DeploymentAlarms

Create a value of DeploymentAlarms 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:alarmNames:DeploymentAlarms', deploymentAlarms_alarmNames - One or more CloudWatch alarm names. Use a "," to separate the alarms.

$sel:enable:DeploymentAlarms', deploymentAlarms_enable - Determines whether to use the CloudWatch alarm option in the service deployment process.

$sel:rollback:DeploymentAlarms', deploymentAlarms_rollback - Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

deploymentAlarms_alarmNames :: Lens' DeploymentAlarms [Text] Source #

One or more CloudWatch alarm names. Use a "," to separate the alarms.

deploymentAlarms_enable :: Lens' DeploymentAlarms Bool Source #

Determines whether to use the CloudWatch alarm option in the service deployment process.

deploymentAlarms_rollback :: Lens' DeploymentAlarms Bool Source #

Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.