Interface CfnDeployment.DeploymentPoliciesProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDeployment.DeploymentPoliciesProperty.Jsii$Proxy
Enclosing class:
CfnDeployment

@Stability(Stable) public static interface CfnDeployment.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.services.greengrassv2.*;
 DeploymentPoliciesProperty deploymentPoliciesProperty = DeploymentPoliciesProperty.builder()
         .componentUpdatePolicy(DeploymentComponentUpdatePolicyProperty.builder()
                 .action("action")
                 .timeoutInSeconds(123)
                 .build())
         .configurationValidationPolicy(DeploymentConfigurationValidationPolicyProperty.builder()
                 .timeoutInSeconds(123)
                 .build())
         .failureHandlingPolicy("failureHandlingPolicy")
         .build();
 
  • 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.

    • 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.

    • 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

    • builder

      @Stability(Stable) static CfnDeployment.DeploymentPoliciesProperty.Builder builder()
      Returns:
      a CfnDeployment.DeploymentPoliciesProperty.Builder of CfnDeployment.DeploymentPoliciesProperty