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(value="software.amazon.awssdk:codegen")
public final class StartInstanceRefreshRequest
extends AutoScalingRequest
implements ToCopyableBuilder<StartInstanceRefreshRequest.Builder,StartInstanceRefreshRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartInstanceRefreshRequest.Builder

Method Summary

Modifier and Type	Method and 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() Set of preferences associated with the instance refresh request.
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.

A rolling update helps you update your instances gradually. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that are replaced are not rolled back to their previous configuration.

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.

A rolling update helps you update your instances gradually. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that are replaced are not rolled back to their previous configuration.

See Also:

RefreshStrategy

strategyAsString

public final String strategyAsString()

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

A rolling update helps you update your instances gradually. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that are replaced are not rolled back to their previous configuration.

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.

A rolling update helps you update your instances gradually. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that are replaced are not rolled back to their previous configuration.

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 version. 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 version. This can help you reduce the number of replacements that are required to apply updates.

preferences

public final RefreshPreferences preferences()

Set of preferences associated with the instance refresh request. If not provided, the default values are used.

Returns:

Set of preferences associated with the instance refresh request. If not provided, the default values are used.

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