interface ZonalConfigProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CodeDeploy.CfnDeploymentConfig.ZonalConfigProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscodedeploy#CfnDeploymentConfig_ZonalConfigProperty |
![]() | software.amazon.awscdk.services.codedeploy.CfnDeploymentConfig.ZonalConfigProperty |
![]() | aws_cdk.aws_codedeploy.CfnDeploymentConfig.ZonalConfigProperty |
![]() | aws-cdk-lib » aws_codedeploy » CfnDeploymentConfig » ZonalConfigProperty |
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 { aws_codedeploy as codedeploy } from 'aws-cdk-lib';
const zonalConfigProperty: codedeploy.CfnDeploymentConfig.ZonalConfigProperty = {
firstZoneMonitorDurationInSeconds: 123,
minimumHealthyHostsPerZone: {
type: 'type',
value: 123,
},
monitorDurationInSeconds: 123,
};
Properties
Name | Type | Description |
---|---|---|
first | number | The period of time, in seconds, that CodeDeploy must wait after completing a deployment to the first Availability Zone. |
minimum | IResolvable | Minimum | The number or percentage of instances that must remain available per Availability Zone during a deployment. |
monitor | number | The period of time, in seconds, that CodeDeploy must wait after completing a deployment to an Availability Zone. |
firstZoneMonitorDurationInSeconds?
Type:
number
(optional)
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 .
minimumHealthyHostsPerZone?
Type:
IResolvable
|
Minimum
(optional)
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 .
monitorDurationInSeconds?
Type:
number
(optional)
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 .