software.amazon.awssdk.services.autoscaling.model

Interface StartInstanceRefreshRequest.Builder

All Superinterfaces:

AutoScalingRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<StartInstanceRefreshRequest.Builder,StartInstanceRefreshRequest>, SdkBuilder<StartInstanceRefreshRequest.Builder,StartInstanceRefreshRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartInstanceRefreshRequest

public static interface StartInstanceRefreshRequest.Builder
extends AutoScalingRequest.Builder, SdkPojo, CopyableBuilder<StartInstanceRefreshRequest.Builder,StartInstanceRefreshRequest>

Method Summary

Modifier and Type	Method and Description
StartInstanceRefreshRequest.Builder	autoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group.
default StartInstanceRefreshRequest.Builder	desiredConfiguration(Consumer<DesiredConfiguration.Builder> desiredConfiguration) The desired configuration.
StartInstanceRefreshRequest.Builder	desiredConfiguration(DesiredConfiguration desiredConfiguration) The desired configuration.
StartInstanceRefreshRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartInstanceRefreshRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
default StartInstanceRefreshRequest.Builder	preferences(Consumer<RefreshPreferences.Builder> preferences) Set of preferences associated with the instance refresh request.
StartInstanceRefreshRequest.Builder	preferences(RefreshPreferences preferences) Set of preferences associated with the instance refresh request.
StartInstanceRefreshRequest.Builder	strategy(RefreshStrategy strategy) The strategy to use for the instance refresh.
StartInstanceRefreshRequest.Builder	strategy(String strategy) The strategy to use for the instance refresh.

Methods inherited from interface software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

autoScalingGroupName

StartInstanceRefreshRequest.Builder autoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group.

Parameters:

autoScalingGroupName - The name of the Auto Scaling group.

Returns:

Returns a reference to this object so that method calls can be chained together.

strategy

StartInstanceRefreshRequest.Builder strategy(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RefreshStrategy, RefreshStrategy

strategy

StartInstanceRefreshRequest.Builder strategy(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RefreshStrategy, RefreshStrategy

desiredConfiguration

StartInstanceRefreshRequest.Builder desiredConfiguration(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

desiredConfiguration

default StartInstanceRefreshRequest.Builder desiredConfiguration(Consumer<DesiredConfiguration.Builder> 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.

This is a convenience method that creates an instance of the DesiredConfiguration.Builder avoiding the need to create one manually via DesiredConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to desiredConfiguration(DesiredConfiguration).

Parameters:

desiredConfiguration - a consumer that will call methods on DesiredConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

desiredConfiguration(DesiredConfiguration)

preferences

StartInstanceRefreshRequest.Builder preferences(RefreshPreferences preferences)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

preferences

default StartInstanceRefreshRequest.Builder preferences(Consumer<RefreshPreferences.Builder> preferences)

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

This is a convenience method that creates an instance of the RefreshPreferences.Builder avoiding the need to create one manually via RefreshPreferences.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to preferences(RefreshPreferences).

Parameters:

preferences - a consumer that will call methods on RefreshPreferences.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

preferences(RefreshPreferences)

overrideConfiguration

StartInstanceRefreshRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StartInstanceRefreshRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder