class Aws::GreengrassV2::Types::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.

@note When making an API call, you may pass DeploymentComponentUpdatePolicy

data as a hash:

    {
      timeout_in_seconds: 1,
      action: "NOTIFY_COMPONENTS", # accepts NOTIFY_COMPONENTS, SKIP_NOTIFY_COMPONENTS
    }

@!attribute [rw] timeout_in_seconds

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`
@return [Integer]

@!attribute [rw] 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][1] IPC operation to receive these
  notifications. Then, components can respond with the
  [DeferComponentUpdate][2] IPC operation. For more information, see
  [Create deployments][3] 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`

[1]: https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetocomponentupdates
[2]: https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-defercomponentupdate
[3]: https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/DeploymentComponentUpdatePolicy AWS API Documentation

Constants

SENSITIVE