Package software.amazon.awssdk.services.autoscaling.model

Class StartInstanceRefreshRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest
software.amazon.awssdk.services.autoscaling.model.StartInstanceRefreshRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartInstanceRefreshRequest.Builder,StartInstanceRefreshRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartInstanceRefreshRequest extends AutoScalingRequest implements ToCopyableBuilder<StartInstanceRefreshRequest.Builder,StartInstanceRefreshRequest>

  • Method Details

    • autoScalingGroupName

      public final String autoScalingGroupName()

      The name of the Auto Scaling group.

      Returns:
      The name of the Auto Scaling group.

    • strategy

      public final RefreshStrategy strategy()

      The strategy to use for the instance refresh. The only valid value is Rolling.

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

      Returns:
      The strategy to use for the instance refresh. The only valid value is Rolling.
      See Also:

    • strategyAsString

      public final String strategyAsString()

      The strategy to use for the instance refresh. The only valid value is Rolling.

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

      Returns:
      The strategy to use for the instance refresh. The only valid value is Rolling.
      See Also:

    • desiredConfiguration

      public final DesiredConfiguration desiredConfiguration()

      The desired configuration. For example, the desired configuration can specify a new launch template or a new version of the current launch template.

      Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to reflect the new desired configuration.

      When you specify a new launch template or a new version of the current launch template for your desired configuration, consider enabling the SkipMatching property in preferences. If it's enabled, Amazon EC2 Auto Scaling skips replacing instances that already use the specified launch template and instance types. This can help you reduce the number of replacements that are required to apply updates.

      Returns:
      The desired configuration. For example, the desired configuration can specify a new launch template or a new version of the current launch template.

      Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to reflect the new desired configuration.

      When you specify a new launch template or a new version of the current launch template for your desired configuration, consider enabling the SkipMatching property in preferences. If it's enabled, Amazon EC2 Auto Scaling skips replacing instances that already use the specified launch template and instance types. This can help you reduce the number of replacements that are required to apply updates.

    • preferences

      public final RefreshPreferences preferences()

      Sets your preferences for the instance refresh so that it performs as expected when you start it. Includes the instance warmup time, the minimum and maximum healthy percentages, and the behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in Standby state or protected from scale in are found. You can also choose to enable additional features, such as the following:

      • Auto rollback

      • Checkpoints

      • CloudWatch alarms

      • Skip matching

      Returns:
      Sets your preferences for the instance refresh so that it performs as expected when you start it. Includes the instance warmup time, the minimum and maximum healthy percentages, and the behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in Standby state or protected from scale in are found. You can also choose to enable additional features, such as the following:

      • Auto rollback

      • Checkpoints

      • CloudWatch alarms

      • Skip matching

    • toBuilder

      public StartInstanceRefreshRequest.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<StartInstanceRefreshRequest.Builder,StartInstanceRefreshRequest>
      Specified by:
      toBuilder in class AutoScalingRequest
      Returns:
      a builder for type T

    • builder

      public static StartInstanceRefreshRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.