AWS::GreengrassV2::Deployment DeploymentComponentUpdatePolicy - AWS CloudFormation
SyntaxProperties

AWS::GreengrassV2::Deployment DeploymentComponentUpdatePolicy

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Action" : String,
  "TimeoutInSeconds" : Integer
}

YAML

  Action: String
  TimeoutInSeconds: Integer

Properties

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 the Create deployments in the AWS 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

Required: No

Type: String

Allowed values: NOTIFY_COMPONENTS | SKIP_NOTIFY_COMPONENTS

Update requires: Replacement

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

Required: No

Type: Integer

Minimum: 1

Maximum: 2147483647

Update requires: Replacement