Class ZonalConfig

java.lang.Object
software.amazon.awssdk.services.codedeploy.model.ZonalConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ZonalConfig.Builder,ZonalConfig>
@Generated("software.amazon.awssdk:codegen") public final class ZonalConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ZonalConfig.Builder,ZonalConfig>

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:

  • Method Details

    • firstZoneMonitorDurationInSeconds

      public final 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.

      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.

    • monitorDurationInSeconds

      public final 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.

      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.

    • minimumHealthyHostsPerZone

      public final 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.

      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.

    • toBuilder

      public ZonalConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ZonalConfig.Builder,ZonalConfig>
      Returns:
      a builder for type T

    • builder

      public static ZonalConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ZonalConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.