Class EC2DeploymentOptions

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

Options that control how CodeDeploy manages Amazon EC2 Auto Scaling groups during a deployment.

See Also:

  • Method Details

    • autoScalingGroupProcessesToSuspend

      public final List<AutoScalingGroupProcess> autoScalingGroupProcessesToSuspend()

      The Amazon EC2 Auto Scaling processes to suspend during the deployment. CodeDeploy suspends these processes before it deploys to instances in an Auto Scaling group, and resumes them when the deployment succeeds, fails, or is stopped. Valid values are Terminate, AZRebalance, InstanceRefresh, and ScheduledActions.

      This parameter applies only to in-place deployments on the EC2/On-premises compute platform. If the list is empty, or if the deployment does not target instances in an Auto Scaling group, no processes are suspended.

      The service role for the deployment group must have permission to call autoscaling:SuspendProcesses and autoscaling:ResumeProcesses on the target Auto Scaling groups. If the processes cannot be suspended, the deployment fails before any instance is updated.

      If you suspend ScheduledActions, scheduled actions with a start time during the deployment are skipped and do not run after the process resumes.

      If CodeDeploy cannot resume the processes, the deployment fails and the processes stay suspended until you resume them with the Auto Scaling ResumeProcesses action. While Terminate is suspended, Auto Scaling does not replace unhealthy instances. If you suspend Terminate, configure a trigger that notifies you when a deployment fails.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAutoScalingGroupProcessesToSuspend() method.

      Returns:
      The Amazon EC2 Auto Scaling processes to suspend during the deployment. CodeDeploy suspends these processes before it deploys to instances in an Auto Scaling group, and resumes them when the deployment succeeds, fails, or is stopped. Valid values are Terminate, AZRebalance, InstanceRefresh, and ScheduledActions.

      This parameter applies only to in-place deployments on the EC2/On-premises compute platform. If the list is empty, or if the deployment does not target instances in an Auto Scaling group, no processes are suspended.

      The service role for the deployment group must have permission to call autoscaling:SuspendProcesses and autoscaling:ResumeProcesses on the target Auto Scaling groups. If the processes cannot be suspended, the deployment fails before any instance is updated.

      If you suspend ScheduledActions, scheduled actions with a start time during the deployment are skipped and do not run after the process resumes.

      If CodeDeploy cannot resume the processes, the deployment fails and the processes stay suspended until you resume them with the Auto Scaling ResumeProcesses action. While Terminate is suspended, Auto Scaling does not replace unhealthy instances. If you suspend Terminate, configure a trigger that notifies you when a deployment fails.

    • hasAutoScalingGroupProcessesToSuspend

      public final boolean hasAutoScalingGroupProcessesToSuspend()
      For responses, this returns true if the service returned a value for the AutoScalingGroupProcessesToSuspend property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • autoScalingGroupProcessesToSuspendAsStrings

      public final List<String> autoScalingGroupProcessesToSuspendAsStrings()

      The Amazon EC2 Auto Scaling processes to suspend during the deployment. CodeDeploy suspends these processes before it deploys to instances in an Auto Scaling group, and resumes them when the deployment succeeds, fails, or is stopped. Valid values are Terminate, AZRebalance, InstanceRefresh, and ScheduledActions.

      This parameter applies only to in-place deployments on the EC2/On-premises compute platform. If the list is empty, or if the deployment does not target instances in an Auto Scaling group, no processes are suspended.

      The service role for the deployment group must have permission to call autoscaling:SuspendProcesses and autoscaling:ResumeProcesses on the target Auto Scaling groups. If the processes cannot be suspended, the deployment fails before any instance is updated.

      If you suspend ScheduledActions, scheduled actions with a start time during the deployment are skipped and do not run after the process resumes.

      If CodeDeploy cannot resume the processes, the deployment fails and the processes stay suspended until you resume them with the Auto Scaling ResumeProcesses action. While Terminate is suspended, Auto Scaling does not replace unhealthy instances. If you suspend Terminate, configure a trigger that notifies you when a deployment fails.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAutoScalingGroupProcessesToSuspend() method.

      Returns:
      The Amazon EC2 Auto Scaling processes to suspend during the deployment. CodeDeploy suspends these processes before it deploys to instances in an Auto Scaling group, and resumes them when the deployment succeeds, fails, or is stopped. Valid values are Terminate, AZRebalance, InstanceRefresh, and ScheduledActions.

      This parameter applies only to in-place deployments on the EC2/On-premises compute platform. If the list is empty, or if the deployment does not target instances in an Auto Scaling group, no processes are suspended.

      The service role for the deployment group must have permission to call autoscaling:SuspendProcesses and autoscaling:ResumeProcesses on the target Auto Scaling groups. If the processes cannot be suspended, the deployment fails before any instance is updated.

      If you suspend ScheduledActions, scheduled actions with a start time during the deployment are skipped and do not run after the process resumes.

      If CodeDeploy cannot resume the processes, the deployment fails and the processes stay suspended until you resume them with the Auto Scaling ResumeProcesses action. While Terminate is suspended, Auto Scaling does not replace unhealthy instances. If you suspend Terminate, configure a trigger that notifies you when a deployment fails.

    • toBuilder

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

    • builder

      public static EC2DeploymentOptions.Builder builder()

    • serializableBuilderClass

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