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.GreengrassV2.Types.DeploymentComponentUpdatePolicy

Description

Documentation

data DeploymentComponentUpdatePolicy Source #

Contains information about a deployment's policy that defines when components are safe to update.

Each component on a device can report whether or not it's ready to update. After a component and its dependencies are ready, they can apply the update in the deployment. You can configure whether or not the deployment notifies components of an update and waits for a response. You specify the amount of time each component has to respond to the update notification.

See: newDeploymentComponentUpdatePolicy smart constructor.

Constructors

DeploymentComponentUpdatePolicy'

Fields

action :: Maybe DeploymentComponentUpdatePolicyAction
Whether or not to notify components and wait for components to become safe to update. Choose from the following options:
- NOTIFY_COMPONENTS – The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see Create deployments in the IoT Greengrass V2 Developer Guide.
- SKIP_NOTIFY_COMPONENTS – The deployment doesn't notify components or wait for them to be safe to update.
Default: NOTIFY_COMPONENTS
timeoutInSeconds :: Maybe Int
The amount of time in seconds that each component on a device has to report that it's safe to update. If the component waits for longer than this timeout, then the deployment proceeds on the device.
Default: 60

Instances

Instances details

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

newDeploymentComponentUpdatePolicy :: DeploymentComponentUpdatePolicy Source #

Create a value of DeploymentComponentUpdatePolicy 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:action:DeploymentComponentUpdatePolicy', deploymentComponentUpdatePolicy_action - Whether or not to notify components and wait for components to become safe to update. Choose from the following options:

NOTIFY_COMPONENTS – The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see Create deployments in the IoT Greengrass V2 Developer Guide.
SKIP_NOTIFY_COMPONENTS – The deployment doesn't notify components or wait for them to be safe to update.

Default: NOTIFY_COMPONENTS

$sel:timeoutInSeconds:DeploymentComponentUpdatePolicy', deploymentComponentUpdatePolicy_timeoutInSeconds - The amount of time in seconds that each component on a device has to report that it's safe to update. If the component waits for longer than this timeout, then the deployment proceeds on the device.

Default: 60

deploymentComponentUpdatePolicy_action :: Lens' DeploymentComponentUpdatePolicy (Maybe DeploymentComponentUpdatePolicyAction) Source #

Whether or not to notify components and wait for components to become safe to update. Choose from the following options:

NOTIFY_COMPONENTS – The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see Create deployments in the IoT Greengrass V2 Developer Guide.
SKIP_NOTIFY_COMPONENTS – The deployment doesn't notify components or wait for them to be safe to update.

Default: NOTIFY_COMPONENTS

deploymentComponentUpdatePolicy_timeoutInSeconds :: Lens' DeploymentComponentUpdatePolicy (Maybe Int) Source #

The amount of time in seconds that each component on a device has to report that it's safe to update. If the component waits for longer than this timeout, then the deployment proceeds on the device.

Default: 60