Package software.amazon.awscdk.services.greengrassv2

Interface CfnDeployment.DeploymentComponentUpdatePolicyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeployment.DeploymentComponentUpdatePolicyProperty.Jsii$Proxy

Enclosing class:

CfnDeployment

@Stability(Stable)
public static interface CfnDeployment.DeploymentComponentUpdatePolicyProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.greengrassv2.*;
 DeploymentComponentUpdatePolicyProperty deploymentComponentUpdatePolicyProperty = DeploymentComponentUpdatePolicyProperty.builder()
         .action("action")
         .timeoutInSeconds(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeployment.DeploymentComponentUpdatePolicyProperty.Builder	A builder for CfnDeployment.DeploymentComponentUpdatePolicyProperty
static final class	CfnDeployment.DeploymentComponentUpdatePolicyProperty.Jsii$Proxy	An implementation for CfnDeployment.DeploymentComponentUpdatePolicyProperty

Method Summary

Modifier and Type	Method	Description
static CfnDeployment.DeploymentComponentUpdatePolicyProperty.Builder	builder()
default String	getAction()	Whether or not to notify components and wait for components to become safe to update.
default Number	getTimeoutInSeconds()	The amount of time in seconds that each component on a device has to report that it's safe to update.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Stable)
@Nullable
default String getAction()

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

getTimeoutInSeconds

@Stability(Stable)
@Nullable
default Number getTimeoutInSeconds()

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

builder

@Stability(Stable)
static CfnDeployment.DeploymentComponentUpdatePolicyProperty.Builder builder()

Returns:

a CfnDeployment.DeploymentComponentUpdatePolicyProperty.Builder of CfnDeployment.DeploymentComponentUpdatePolicyProperty