software.amazon.awssdk.services.autoscaling.model

Interface AutoScalingInstanceDetails.Builder

All Superinterfaces:

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

Enclosing class:

AutoScalingInstanceDetails

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

Method Summary

Modifier and Type	Method and Description
AutoScalingInstanceDetails.Builder	autoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group for the instance.
AutoScalingInstanceDetails.Builder	availabilityZone(String availabilityZone) The Availability Zone for the instance.
AutoScalingInstanceDetails.Builder	healthStatus(String healthStatus) The last reported health status of this instance.
AutoScalingInstanceDetails.Builder	instanceId(String instanceId) The ID of the instance.
AutoScalingInstanceDetails.Builder	instanceType(String instanceType) The instance type of the EC2 instance.
AutoScalingInstanceDetails.Builder	launchConfigurationName(String launchConfigurationName) The launch configuration used to launch the instance.
default AutoScalingInstanceDetails.Builder	launchTemplate(Consumer<LaunchTemplateSpecification.Builder> launchTemplate) The launch template for the instance.
AutoScalingInstanceDetails.Builder	launchTemplate(LaunchTemplateSpecification launchTemplate) The launch template for the instance.
AutoScalingInstanceDetails.Builder	lifecycleState(String lifecycleState) The lifecycle state for the instance.
AutoScalingInstanceDetails.Builder	protectedFromScaleIn(Boolean protectedFromScaleIn) Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
AutoScalingInstanceDetails.Builder	weightedCapacity(String weightedCapacity) The number of capacity units contributed by the instance based on its instance type.

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

instanceId

AutoScalingInstanceDetails.Builder instanceId(String instanceId)

The ID of the instance.

Parameters:

instanceId - The ID of the instance.

Returns:

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

instanceType

AutoScalingInstanceDetails.Builder instanceType(String instanceType)

The instance type of the EC2 instance.

Parameters:

instanceType - The instance type of the EC2 instance.

Returns:

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

autoScalingGroupName

AutoScalingInstanceDetails.Builder autoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group for the instance.

Parameters:

autoScalingGroupName - The name of the Auto Scaling group for the instance.

Returns:

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

availabilityZone

AutoScalingInstanceDetails.Builder availabilityZone(String availabilityZone)

The Availability Zone for the instance.

Parameters:

availabilityZone - The Availability Zone for the instance.

Returns:

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

lifecycleState

AutoScalingInstanceDetails.Builder lifecycleState(String lifecycleState)

The lifecycle state for the instance. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

Valid values: Pending | Pending:Wait | Pending:Proceed | Quarantined | InService | Terminating | Terminating:Wait | Terminating:Proceed | Terminated | Detaching | Detached | EnteringStandby | Standby | Warmed:Pending | Warmed:Pending:Wait | Warmed:Pending:Proceed | Warmed:Terminating | Warmed:Terminating:Wait | Warmed:Terminating:Proceed | Warmed:Terminated | Warmed:Stopped | Warmed:Running

Parameters:

lifecycleState - The lifecycle state for the instance. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

Valid values: Pending | Pending:Wait | Pending:Proceed | Quarantined | InService | Terminating | Terminating:Wait | Terminating:Proceed | Terminated | Detaching | Detached | EnteringStandby | Standby | Warmed:Pending | Warmed:Pending:Wait | Warmed:Pending:Proceed | Warmed:Terminating | Warmed:Terminating:Wait | Warmed:Terminating:Proceed | Warmed:Terminated | Warmed:Stopped | Warmed:Running

Returns:

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

healthStatus

AutoScalingInstanceDetails.Builder healthStatus(String healthStatus)

The last reported health status of this instance. Healthy means that the instance is healthy and should remain in service. Unhealthy means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.

Parameters:

healthStatus - The last reported health status of this instance. Healthy means that the instance is healthy and should remain in service. Unhealthy means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.

Returns:

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

launchConfigurationName

AutoScalingInstanceDetails.Builder launchConfigurationName(String launchConfigurationName)

The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.

Parameters:

launchConfigurationName - The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.

Returns:

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

launchTemplate

AutoScalingInstanceDetails.Builder launchTemplate(LaunchTemplateSpecification launchTemplate)

The launch template for the instance.

Parameters:

launchTemplate - The launch template for the instance.

Returns:

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

launchTemplate

default AutoScalingInstanceDetails.Builder launchTemplate(Consumer<LaunchTemplateSpecification.Builder> launchTemplate)

The launch template for the instance.

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

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

Parameters:

launchTemplate - a consumer that will call methods on LaunchTemplateSpecification.Builder

Returns:

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

See Also:

launchTemplate(LaunchTemplateSpecification)

protectedFromScaleIn

AutoScalingInstanceDetails.Builder protectedFromScaleIn(Boolean protectedFromScaleIn)

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

Parameters:

protectedFromScaleIn - Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

Returns:

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

weightedCapacity

AutoScalingInstanceDetails.Builder weightedCapacity(String weightedCapacity)

The number of capacity units contributed by the instance based on its instance type.

Valid Range: Minimum value of 1. Maximum value of 999.

Parameters:

weightedCapacity - The number of capacity units contributed by the instance based on its instance type.

Valid Range: Minimum value of 1. Maximum value of 999.

Returns:

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