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>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StartInstanceRefreshRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`autoScalingGroupName()`	The name of the Auto Scaling group.
`static StartInstanceRefreshRequest.Builder`	`builder()`
`DesiredConfiguration`	`desiredConfiguration()`	The desired configuration.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`RefreshPreferences`	`preferences()`	Sets your preferences for the instance refresh so that it performs as expected when you start it.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartInstanceRefreshRequest.Builder>`	`serializableBuilderClass()`
`RefreshStrategy`	`strategy()`	The strategy to use for the instance refresh.
`String`	`strategyAsString()`	The strategy to use for the instance refresh.
`StartInstanceRefreshRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    RefreshStrategy
  - 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:
    
    RefreshStrategy
  - 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
    
    Bake time
    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
    
    Bake time
  - toBuilder
```
public StartInstanceRefreshRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartInstanceRefreshRequest.Builder,StartInstanceRefreshRequest>
    
    Specified by:
    
    toBuilder in class AutoScalingRequest
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class StartInstanceRefreshRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

autoScalingGroupName

strategy

strategyAsString

desiredConfiguration

preferences

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField