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
-
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.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
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
.- Parameters:
strategy
- The strategy to use for the instance refresh. The only valid value isRolling
.- 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
.- Parameters:
strategy
- The strategy to use for the instance refresh. The only valid value isRolling
.- 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 instance types. 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 instance types. 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 instance types. This can help you reduce the number of replacements that are required to apply updates.DesiredConfiguration.Builder
avoiding the need to create one manually viaDesiredConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todesiredConfiguration(DesiredConfiguration)
.- Parameters:
desiredConfiguration
- a consumer that will call methods onDesiredConfiguration.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)
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
- Parameters:
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 inStandby
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:
- Returns a reference to this object so that method calls can be chained together.
-
-
preferences
default StartInstanceRefreshRequest.Builder preferences(Consumer<RefreshPreferences.Builder> 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
RefreshPreferences.Builder
avoiding the need to create one manually viaRefreshPreferences.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topreferences(RefreshPreferences)
.- Parameters:
preferences
- a consumer that will call methods onRefreshPreferences.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 interfaceAwsRequest.Builder
-
overrideConfiguration
StartInstanceRefreshRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-