ZonalConfig (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.codedeploy.model

Class ZonalConfig

java.lang.Object
- com.amazonaws.services.codedeploy.model.ZonalConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ZonalConfig
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
Configure the ZonalConfig object if you want CodeDeploy to deploy your application to one Availability Zone at a time, within an Amazon Web Services 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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ZonalConfig ()

Constructors
Constructor and Description
`ZonalConfig ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`ZonalConfig`	`clone ()`
`boolean`	`equals (Object obj)`
`Long`	`getFirstZoneMonitorDurationInSeconds ()` The period of time, in seconds, that CodeDeploy must wait after completing a deployment to the first Availability Zone.
`MinimumHealthyHostsPerZone`	`getMinimumHealthyHostsPerZone ()` The number or percentage of instances that must remain available per Availability Zone during a deployment.
`Long`	`getMonitorDurationInSeconds ()` The period of time, in seconds, that CodeDeploy must wait after completing a deployment to an Availability Zone.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setFirstZoneMonitorDurationInSeconds (Long firstZoneMonitorDurationInSeconds)` The period of time, in seconds, that CodeDeploy must wait after completing a deployment to the first Availability Zone.
`void`	`setMinimumHealthyHostsPerZone (MinimumHealthyHostsPerZone minimumHealthyHostsPerZone)` The number or percentage of instances that must remain available per Availability Zone during a deployment.
`void`	`setMonitorDurationInSeconds (Long monitorDurationInSeconds)` The period of time, in seconds, that CodeDeploy must wait after completing a deployment to an Availability Zone.
`String`	`toString ()` Returns a string representation of this object.
`ZonalConfig`	`withFirstZoneMonitorDurationInSeconds (Long firstZoneMonitorDurationInSeconds)` The period of time, in seconds, that CodeDeploy must wait after completing a deployment to the first Availability Zone.
`ZonalConfig`	`withMinimumHealthyHostsPerZone (MinimumHealthyHostsPerZone minimumHealthyHostsPerZone)` The number or percentage of instances that must remain available per Availability Zone during a deployment.
`ZonalConfig`	`withMonitorDurationInSeconds (Long monitorDurationInSeconds)` The period of time, in seconds, that CodeDeploy must wait after completing a deployment to an Availability Zone.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ZonalConfig
```
public ZonalConfig()
```
- Method Detail
  - setFirstZoneMonitorDurationInSeconds
```
public void setFirstZoneMonitorDurationInSeconds(Long firstZoneMonitorDurationInSeconds)
```
    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.
    
    Parameters:
    
    firstZoneMonitorDurationInSeconds - 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.
  - getFirstZoneMonitorDurationInSeconds
```
public Long 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.
    
    Returns:
    
    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.
  - withFirstZoneMonitorDurationInSeconds
```
public ZonalConfig withFirstZoneMonitorDurationInSeconds(Long firstZoneMonitorDurationInSeconds)
```
    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.
    
    Parameters:
    
    firstZoneMonitorDurationInSeconds - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMonitorDurationInSeconds
```
public void setMonitorDurationInSeconds(Long monitorDurationInSeconds)
```
    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.
    
    Parameters:
    
    monitorDurationInSeconds - 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.
  - getMonitorDurationInSeconds
```
public Long 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.
    
    Returns:
    
    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.
  - withMonitorDurationInSeconds
```
public ZonalConfig withMonitorDurationInSeconds(Long monitorDurationInSeconds)
```
    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.
    
    Parameters:
    
    monitorDurationInSeconds - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMinimumHealthyHostsPerZone
```
public void setMinimumHealthyHostsPerZone(MinimumHealthyHostsPerZone minimumHealthyHostsPerZone)
```
    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.
    
    Parameters:
    
    minimumHealthyHostsPerZone - 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.
  - getMinimumHealthyHostsPerZone
```
public MinimumHealthyHostsPerZone 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:
    
    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.
  - withMinimumHealthyHostsPerZone
```
public ZonalConfig withMinimumHealthyHostsPerZone(MinimumHealthyHostsPerZone minimumHealthyHostsPerZone)
```
    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.
    
    Parameters:
    
    minimumHealthyHostsPerZone - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ZonalConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class ZonalConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ZonalConfig

Method Detail

setFirstZoneMonitorDurationInSeconds

getFirstZoneMonitorDurationInSeconds

withFirstZoneMonitorDurationInSeconds

setMonitorDurationInSeconds

getMonitorDurationInSeconds

withMonitorDurationInSeconds

setMinimumHealthyHostsPerZone

getMinimumHealthyHostsPerZone

withMinimumHealthyHostsPerZone

toString

equals

hashCode

clone

marshall