Package software.amazon.awscdk.services.codedeploy

Interface CfnDeploymentConfig.ZonalConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeploymentConfig.ZonalConfigProperty.Jsii$Proxy

Enclosing class:

CfnDeploymentConfig

@Stability(Stable)
public static interface CfnDeploymentConfig.ZonalConfigProperty
extends software.amazon.jsii.JsiiSerializable

Configure the ZonalConfig object if you want AWS CodeDeploy to deploy your application to one Availability Zone at a time, within an AWS Region. By deploying to one Availability Zone at a time, you can expose your deployment to a progressively larger audience as confidence in the deployment's performance and viability grows. If you don't configure the ZonalConfig object, CodeDeploy deploys your application to a random selection of hosts across a Region.

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide .

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.codedeploy.*;
 ZonalConfigProperty zonalConfigProperty = ZonalConfigProperty.builder()
         .firstZoneMonitorDurationInSeconds(123)
         .minimumHealthyHostsPerZone(MinimumHealthyHostsPerZoneProperty.builder()
                 .type("type")
                 .value(123)
                 .build())
         .monitorDurationInSeconds(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-zonalconfig.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDeploymentConfig.ZonalConfigProperty.Builder	builder()
default Number	getFirstZoneMonitorDurationInSeconds()	The period of time, in seconds, that CodeDeploy must wait after completing a deployment to the first Availability Zone.
default Object	getMinimumHealthyHostsPerZone()	The number or percentage of instances that must remain available per Availability Zone during a deployment.
default Number	getMonitorDurationInSeconds()	The period of time, in seconds, that CodeDeploy must wait after completing a deployment to an Availability Zone.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFirstZoneMonitorDurationInSeconds

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

The period of time, in seconds, that CodeDeploy must wait after completing a deployment to the first Availability Zone.

CodeDeploy will wait this amount of time before starting a deployment to the second Availability Zone. You might set this option if you want to allow extra bake time for the first Availability Zone. If you don't specify a value for firstZoneMonitorDurationInSeconds , then CodeDeploy uses the monitorDurationInSeconds value for the first Availability Zone.

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-zonalconfig.html#cfn-codedeploy-deploymentconfig-zonalconfig-firstzonemonitordurationinseconds

getMinimumHealthyHostsPerZone

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

The number or percentage of instances that must remain available per Availability Zone during a deployment.

This option works in conjunction with the MinimumHealthyHosts option. For more information, see About the minimum number of healthy hosts per Availability Zone in the CodeDeploy User Guide .

If you don't specify the minimumHealthyHostsPerZone option, then CodeDeploy uses a default value of 0 percent.

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide .

Returns union: either IResolvable or CfnDeploymentConfig.MinimumHealthyHostsPerZoneProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-zonalconfig.html#cfn-codedeploy-deploymentconfig-zonalconfig-minimumhealthyhostsperzone

getMonitorDurationInSeconds

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

The period of time, in seconds, that CodeDeploy must wait after completing a deployment to an Availability Zone.

CodeDeploy will wait this amount of time before starting a deployment to the next Availability Zone. Consider adding a monitor duration to give the deployment some time to prove itself (or 'bake') in one Availability Zone before it is released in the next zone. If you don't specify a monitorDurationInSeconds , CodeDeploy starts deploying to the next Availability Zone immediately.

For more information about the zonal configuration feature, see zonal configuration in the CodeDeploy User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-zonalconfig.html#cfn-codedeploy-deploymentconfig-zonalconfig-monitordurationinseconds

builder

@Stability(Stable)
static CfnDeploymentConfig.ZonalConfigProperty.Builder builder()

Returns:

a CfnDeploymentConfig.ZonalConfigProperty.Builder of CfnDeploymentConfig.ZonalConfigProperty