AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::GreengrassV2::Model::DeploymentComponentUpdatePolicy Class Reference

#include <DeploymentComponentUpdatePolicy.h>

Public Member Functions

 DeploymentComponentUpdatePolicy ()
 
 DeploymentComponentUpdatePolicy (Aws::Utils::Json::JsonView jsonValue)
 
DeploymentComponentUpdatePolicyoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetTimeoutInSeconds () const
 
bool TimeoutInSecondsHasBeenSet () const
 
void SetTimeoutInSeconds (int value)
 
DeploymentComponentUpdatePolicyWithTimeoutInSeconds (int value)
 
const DeploymentComponentUpdatePolicyActionGetAction () const
 
bool ActionHasBeenSet () const
 
void SetAction (const DeploymentComponentUpdatePolicyAction &value)
 
void SetAction (DeploymentComponentUpdatePolicyAction &&value)
 
DeploymentComponentUpdatePolicyWithAction (const DeploymentComponentUpdatePolicyAction &value)
 
DeploymentComponentUpdatePolicyWithAction (DeploymentComponentUpdatePolicyAction &&value)
 

Detailed Description

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 Also:

AWS API Reference

Definition at line 37 of file DeploymentComponentUpdatePolicy.h.

Constructor & Destructor Documentation

◆ DeploymentComponentUpdatePolicy() [1/2]

Aws::GreengrassV2::Model::DeploymentComponentUpdatePolicy::DeploymentComponentUpdatePolicy ( )

◆ DeploymentComponentUpdatePolicy() [2/2]

Aws::GreengrassV2::Model::DeploymentComponentUpdatePolicy::DeploymentComponentUpdatePolicy ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ActionHasBeenSet()

bool Aws::GreengrassV2::Model::DeploymentComponentUpdatePolicy::ActionHasBeenSet ( ) const
inline

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

Definition at line 109 of file DeploymentComponentUpdatePolicy.h.

◆ GetAction()

const DeploymentComponentUpdatePolicyAction& Aws::GreengrassV2::Model::DeploymentComponentUpdatePolicy::GetAction ( ) const
inline

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

Definition at line 91 of file DeploymentComponentUpdatePolicy.h.

◆ GetTimeoutInSeconds()

int Aws::GreengrassV2::Model::DeploymentComponentUpdatePolicy::GetTimeoutInSeconds ( ) const
inline

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

Definition at line 51 of file DeploymentComponentUpdatePolicy.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::GreengrassV2::Model::DeploymentComponentUpdatePolicy::Jsonize ( ) const

◆ operator=()

DeploymentComponentUpdatePolicy& Aws::GreengrassV2::Model::DeploymentComponentUpdatePolicy::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetAction() [1/2]

void Aws::GreengrassV2::Model::DeploymentComponentUpdatePolicy::SetAction ( const DeploymentComponentUpdatePolicyAction value)
inline

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

Definition at line 127 of file DeploymentComponentUpdatePolicy.h.

◆ SetAction() [2/2]

void Aws::GreengrassV2::Model::DeploymentComponentUpdatePolicy::SetAction ( DeploymentComponentUpdatePolicyAction &&  value)
inline

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

Definition at line 145 of file DeploymentComponentUpdatePolicy.h.

◆ SetTimeoutInSeconds()

void Aws::GreengrassV2::Model::DeploymentComponentUpdatePolicy::SetTimeoutInSeconds ( int  value)
inline

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

Definition at line 65 of file DeploymentComponentUpdatePolicy.h.

◆ TimeoutInSecondsHasBeenSet()

bool Aws::GreengrassV2::Model::DeploymentComponentUpdatePolicy::TimeoutInSecondsHasBeenSet ( ) const
inline

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

Definition at line 58 of file DeploymentComponentUpdatePolicy.h.

◆ WithAction() [1/2]

DeploymentComponentUpdatePolicy& Aws::GreengrassV2::Model::DeploymentComponentUpdatePolicy::WithAction ( const DeploymentComponentUpdatePolicyAction value)
inline

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

Definition at line 163 of file DeploymentComponentUpdatePolicy.h.

◆ WithAction() [2/2]

DeploymentComponentUpdatePolicy& Aws::GreengrassV2::Model::DeploymentComponentUpdatePolicy::WithAction ( DeploymentComponentUpdatePolicyAction &&  value)
inline

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

Definition at line 181 of file DeploymentComponentUpdatePolicy.h.

◆ WithTimeoutInSeconds()

DeploymentComponentUpdatePolicy& Aws::GreengrassV2::Model::DeploymentComponentUpdatePolicy::WithTimeoutInSeconds ( int  value)
inline

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

Definition at line 72 of file DeploymentComponentUpdatePolicy.h.


The documentation for this class was generated from the following file: