software.amazon.awssdk.services.autoscaling.model

Interface InstanceRefresh.Builder

All Superinterfaces:

Buildable, CopyableBuilder<InstanceRefresh.Builder,InstanceRefresh>, SdkBuilder<InstanceRefresh.Builder,InstanceRefresh>, SdkPojo

Enclosing class:

InstanceRefresh

public static interface InstanceRefresh.Builder
extends SdkPojo, CopyableBuilder<InstanceRefresh.Builder,InstanceRefresh>

Method Summary

Modifier and Type	Method and Description
InstanceRefresh.Builder	autoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group.
default InstanceRefresh.Builder	desiredConfiguration(Consumer<DesiredConfiguration.Builder> desiredConfiguration) Describes the specific update you want to deploy.
InstanceRefresh.Builder	desiredConfiguration(DesiredConfiguration desiredConfiguration) Describes the specific update you want to deploy.
InstanceRefresh.Builder	endTime(Instant endTime) The date and time at which the instance refresh ended.
InstanceRefresh.Builder	instanceRefreshId(String instanceRefreshId) The instance refresh ID.
InstanceRefresh.Builder	instancesToUpdate(Integer instancesToUpdate) The number of instances remaining to update before the instance refresh is complete.
InstanceRefresh.Builder	percentageComplete(Integer percentageComplete) The percentage of the instance refresh that is complete.
default InstanceRefresh.Builder	preferences(Consumer<RefreshPreferences.Builder> preferences) Sets the value of the Preferences property for this object.
InstanceRefresh.Builder	preferences(RefreshPreferences preferences) Sets the value of the Preferences property for this object.
default InstanceRefresh.Builder	progressDetails(Consumer<InstanceRefreshProgressDetails.Builder> progressDetails) Additional progress details for an Auto Scaling group that has a warm pool.
InstanceRefresh.Builder	progressDetails(InstanceRefreshProgressDetails progressDetails) Additional progress details for an Auto Scaling group that has a warm pool.
InstanceRefresh.Builder	startTime(Instant startTime) The date and time at which the instance refresh began.
InstanceRefresh.Builder	status(InstanceRefreshStatus status) The current status for the instance refresh operation:
InstanceRefresh.Builder	status(String status) The current status for the instance refresh operation:
InstanceRefresh.Builder	statusReason(String statusReason) Provides more details about the current status of the instance refresh.

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

instanceRefreshId

InstanceRefresh.Builder instanceRefreshId(String instanceRefreshId)

The instance refresh ID.

Parameters:

instanceRefreshId - The instance refresh ID.

Returns:

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

autoScalingGroupName

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

status

InstanceRefresh.Builder status(String status)

The current status for the instance refresh operation:

• Pending - The request was created, but the operation has not started.

• InProgress - The operation is in progress.

• Successful - The operation completed successfully.

• Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.

• Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

• Cancelled - The operation is cancelled.

Parameters:

status - The current status for the instance refresh operation:

• Pending - The request was created, but the operation has not started.

• InProgress - The operation is in progress.

• Successful - The operation completed successfully.

• Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.

• Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

• Cancelled - The operation is cancelled.

Returns:

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

See Also:

InstanceRefreshStatus, InstanceRefreshStatus

status

InstanceRefresh.Builder status(InstanceRefreshStatus status)

The current status for the instance refresh operation:

• Pending - The request was created, but the operation has not started.

• InProgress - The operation is in progress.

• Successful - The operation completed successfully.

• Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.

• Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

• Cancelled - The operation is cancelled.

Parameters:

status - The current status for the instance refresh operation:

• Pending - The request was created, but the operation has not started.

• InProgress - The operation is in progress.

• Successful - The operation completed successfully.

• Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.

• Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

• Cancelled - The operation is cancelled.

Returns:

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

See Also:

InstanceRefreshStatus, InstanceRefreshStatus

statusReason

InstanceRefresh.Builder statusReason(String statusReason)

Provides more details about the current status of the instance refresh.

Parameters:

statusReason - Provides more details about the current status of the instance refresh.

Returns:

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

startTime

InstanceRefresh.Builder startTime(Instant startTime)

The date and time at which the instance refresh began.

Parameters:

startTime - The date and time at which the instance refresh began.

Returns:

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

endTime

InstanceRefresh.Builder endTime(Instant endTime)

The date and time at which the instance refresh ended.

Parameters:

endTime - The date and time at which the instance refresh ended.

Returns:

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

percentageComplete

InstanceRefresh.Builder percentageComplete(Integer percentageComplete)

The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.

Parameters:

percentageComplete - The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.

Returns:

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

instancesToUpdate

InstanceRefresh.Builder instancesToUpdate(Integer instancesToUpdate)

The number of instances remaining to update before the instance refresh is complete.

Parameters:

instancesToUpdate - The number of instances remaining to update before the instance refresh is complete.

Returns:

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

progressDetails

InstanceRefresh.Builder progressDetails(InstanceRefreshProgressDetails progressDetails)

Additional progress details for an Auto Scaling group that has a warm pool.

Parameters:

progressDetails - Additional progress details for an Auto Scaling group that has a warm pool.

Returns:

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

progressDetails

default InstanceRefresh.Builder progressDetails(Consumer<InstanceRefreshProgressDetails.Builder> progressDetails)

Additional progress details for an Auto Scaling group that has a warm pool.

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

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

Parameters:

progressDetails - a consumer that will call methods on InstanceRefreshProgressDetails.Builder

Returns:

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

See Also:

progressDetails(InstanceRefreshProgressDetails)

preferences

InstanceRefresh.Builder preferences(RefreshPreferences preferences)

Sets the value of the Preferences property for this object.

Parameters:

preferences - The new value for the Preferences property for this object.

Returns:

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

preferences

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

Sets the value of the Preferences property for this object. 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)

desiredConfiguration

InstanceRefresh.Builder desiredConfiguration(DesiredConfiguration desiredConfiguration)

Describes the specific update you want to deploy.

Parameters:

desiredConfiguration - Describes the specific update you want to deploy.

Returns:

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

desiredConfiguration

default InstanceRefresh.Builder desiredConfiguration(Consumer<DesiredConfiguration.Builder> desiredConfiguration)

Describes the specific update you want to deploy.

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)