Class DeploymentReadyOption

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

Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.

See Also:

  • Method Details

    • actionOnTimeout

      public final DeploymentReadyAction actionOnTimeout()

      Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.

      • CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.

      • STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.

      If the service returns an enum value that is not available in the current SDK version, actionOnTimeout will return DeploymentReadyAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionOnTimeoutAsString().

      Returns:
      Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.

      • CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.

      • STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.

      See Also:

    • actionOnTimeoutAsString

      public final String actionOnTimeoutAsString()

      Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.

      • CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.

      • STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.

      If the service returns an enum value that is not available in the current SDK version, actionOnTimeout will return DeploymentReadyAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionOnTimeoutAsString().

      Returns:
      Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.

      • CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.

      • STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.

      See Also:

    • waitTimeInMinutes

      public final Integer waitTimeInMinutes()

      The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually. Applies only to the STOP_DEPLOYMENT option for actionOnTimeout.

      Returns:
      The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually. Applies only to the STOP_DEPLOYMENT option for actionOnTimeout.

    • toBuilder

      public DeploymentReadyOption.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<DeploymentReadyOption.Builder,DeploymentReadyOption>
      Returns:
      a builder for type T

    • builder

      public static DeploymentReadyOption.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DeploymentReadyOption.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.