Package software.amazon.awscdk.cfnpropertymixins.services.greengrassv2

Interface CfnDeploymentPropsMixin.DeploymentPoliciesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeploymentPropsMixin.DeploymentPoliciesProperty.Jsii$Proxy

Enclosing class:

CfnDeploymentPropsMixin

@Stability(Stable)
public static interface CfnDeploymentPropsMixin.DeploymentPoliciesProperty
extends software.amazon.jsii.JsiiSerializable

Contains information about policies that define how a deployment updates components and handles failure.

Example:

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentpolicies.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDeploymentPropsMixin.DeploymentPoliciesProperty.Builder	builder()
default Object	getComponentUpdatePolicy()	The component update policy for the configuration deployment.
default Object	getConfigurationValidationPolicy()	The configuration validation policy for the configuration deployment.
default String	getFailureHandlingPolicy()	The failure handling policy for the configuration deployment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComponentUpdatePolicy

@Stability(Stable)
@Nullable
default Object getComponentUpdatePolicy()

The component update policy for the configuration deployment.

This policy defines when it's safe to deploy the configuration to devices.

Returns union: either IResolvable or CfnDeploymentPropsMixin.DeploymentComponentUpdatePolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentpolicies.html#cfn-greengrassv2-deployment-deploymentpolicies-componentupdatepolicy

getConfigurationValidationPolicy

@Stability(Stable)
@Nullable
default Object getConfigurationValidationPolicy()

The configuration validation policy for the configuration deployment.

This policy defines how long each component has to validate its configure updates.

Returns union: either IResolvable or CfnDeploymentPropsMixin.DeploymentConfigurationValidationPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentpolicies.html#cfn-greengrassv2-deployment-deploymentpolicies-configurationvalidationpolicy

getFailureHandlingPolicy

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

The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.

Default: ROLLBACK

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentpolicies.html#cfn-greengrassv2-deployment-deploymentpolicies-failurehandlingpolicy

builder

@Stability(Stable)
static CfnDeploymentPropsMixin.DeploymentPoliciesProperty.Builder builder()

Returns:

a CfnDeploymentPropsMixin.DeploymentPoliciesProperty.Builder of CfnDeploymentPropsMixin.DeploymentPoliciesProperty