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 desired configuration for the instance refresh.
InstanceRefresh.Builder	desiredConfiguration(DesiredConfiguration desiredConfiguration) Describes the desired configuration for the instance refresh.
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.
default InstanceRefresh.Builder	rollbackDetails(Consumer<RollbackDetails.Builder> rollbackDetails) The rollback details.
InstanceRefresh.Builder	rollbackDetails(RollbackDetails rollbackDetails) The rollback details.
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) The explanation for the specific status assigned to this operation.

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 instance refresh has not started.

• InProgress - An instance refresh is in progress.

• Successful - An instance refresh completed successfully.

• Failed - An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities.

• Cancelling - An ongoing instance refresh is being cancelled.

• Cancelled - The instance refresh is cancelled.

• RollbackInProgress - An instance refresh is being rolled back.

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

• RollbackSuccessful - The rollback completed successfully.

Parameters:

status - The current status for the instance refresh operation:

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

• InProgress - An instance refresh is in progress.

• Successful - An instance refresh completed successfully.

• Failed - An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities.

• Cancelling - An ongoing instance refresh is being cancelled.

• Cancelled - The instance refresh is cancelled.

• RollbackInProgress - An instance refresh is being rolled back.

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

• RollbackSuccessful - The rollback completed successfully.

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 instance refresh has not started.

• InProgress - An instance refresh is in progress.

• Successful - An instance refresh completed successfully.

• Failed - An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities.

• Cancelling - An ongoing instance refresh is being cancelled.

• Cancelled - The instance refresh is cancelled.

• RollbackInProgress - An instance refresh is being rolled back.

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

• RollbackSuccessful - The rollback completed successfully.

Parameters:

status - The current status for the instance refresh operation:

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

• InProgress - An instance refresh is in progress.

• Successful - An instance refresh completed successfully.

• Failed - An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities.

• Cancelling - An ongoing instance refresh is being cancelled.

• Cancelled - The instance refresh is cancelled.

• RollbackInProgress - An instance refresh is being rolled back.

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

• RollbackSuccessful - The rollback completed successfully.

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)

The explanation for the specific status assigned to this operation.

Parameters:

statusReason - The explanation for the specific status assigned to this operation.

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.

PercentageComplete does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback.

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.

PercentageComplete does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback.

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.

If you roll back the instance refresh, InstancesToUpdate shows you the number of instances that were not yet updated by the instance refresh. Therefore, these instances don't need to be replaced as part of the rollback.

Parameters:

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

If you roll back the instance refresh, InstancesToUpdate shows you the number of instances that were not yet updated by the instance refresh. Therefore, these instances don't need to be replaced as part of the rollback.

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 desired configuration for the instance refresh.

Parameters:

desiredConfiguration - Describes the desired configuration for the instance refresh.

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 desired configuration for the instance refresh.

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)

rollbackDetails

InstanceRefresh.Builder rollbackDetails(RollbackDetails rollbackDetails)

The rollback details.

Parameters:

rollbackDetails - The rollback details.

Returns:

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

rollbackDetails

default InstanceRefresh.Builder rollbackDetails(Consumer<RollbackDetails.Builder> rollbackDetails)

The rollback details.

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

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

Parameters:

rollbackDetails - a consumer that will call methods on RollbackDetails.Builder

Returns:

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

See Also:

rollbackDetails(RollbackDetails)