com.amazonaws.services.autoscaling.model

Class Instance

java.lang.Object

com.amazonaws.services.autoscaling.model.Instance

All Implemented Interfaces:

java.io.Serializable

public class Instance
extends java.lang.Object
implements java.io.Serializable

Describes an EC2 instance.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Instance()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAvailabilityZone() The Availability Zone in which the instance is running.
java.lang.String	getHealthStatus() The last reported health status of the instance.
java.lang.String	getInstanceId() The ID of the instance.
java.lang.String	getInstanceType() The instance type of the EC2 instance.
java.lang.String	getLaunchConfigurationName() The launch configuration associated with the instance.
LaunchTemplateSpecification	getLaunchTemplate() The launch template for the instance.
java.lang.String	getLifecycleState() A description of the current lifecycle state.
java.lang.Boolean	getProtectedFromScaleIn() Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
java.lang.String	getWeightedCapacity() The number of capacity units contributed by the instance based on its instance type.
int	hashCode()
java.lang.Boolean	isProtectedFromScaleIn() Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
void	setAvailabilityZone(java.lang.String availabilityZone) The Availability Zone in which the instance is running.
void	setHealthStatus(java.lang.String healthStatus) The last reported health status of the instance.
void	setInstanceId(java.lang.String instanceId) The ID of the instance.
void	setInstanceType(java.lang.String instanceType) The instance type of the EC2 instance.
void	setLaunchConfigurationName(java.lang.String launchConfigurationName) The launch configuration associated with the instance.
void	setLaunchTemplate(LaunchTemplateSpecification launchTemplate) The launch template for the instance.
void	setLifecycleState(LifecycleState lifecycleState) A description of the current lifecycle state.
void	setLifecycleState(java.lang.String lifecycleState) A description of the current lifecycle state.
void	setProtectedFromScaleIn(java.lang.Boolean protectedFromScaleIn) Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
void	setWeightedCapacity(java.lang.String weightedCapacity) The number of capacity units contributed by the instance based on its instance type.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
Instance	withAvailabilityZone(java.lang.String availabilityZone) The Availability Zone in which the instance is running.
Instance	withHealthStatus(java.lang.String healthStatus) The last reported health status of the instance.
Instance	withInstanceId(java.lang.String instanceId) The ID of the instance.
Instance	withInstanceType(java.lang.String instanceType) The instance type of the EC2 instance.
Instance	withLaunchConfigurationName(java.lang.String launchConfigurationName) The launch configuration associated with the instance.
Instance	withLaunchTemplate(LaunchTemplateSpecification launchTemplate) The launch template for the instance.
Instance	withLifecycleState(LifecycleState lifecycleState) A description of the current lifecycle state.
Instance	withLifecycleState(java.lang.String lifecycleState) A description of the current lifecycle state.
Instance	withProtectedFromScaleIn(java.lang.Boolean protectedFromScaleIn) Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
Instance	withWeightedCapacity(java.lang.String weightedCapacity) The number of capacity units contributed by the instance based on its instance type.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Instance

public Instance()

Method Detail

getInstanceId

public java.lang.String getInstanceId()

The ID of the instance.

Constraints:
Length: 1 - 19
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Returns:

The ID of the instance.

setInstanceId

public void setInstanceId(java.lang.String instanceId)

The ID of the instance.

Constraints:
Length: 1 - 19
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

instanceId -

The ID of the instance.

withInstanceId

public Instance withInstanceId(java.lang.String instanceId)

The ID of the instance.

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

Constraints:
Length: 1 - 19
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

instanceId -

The ID of the instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getInstanceType

public java.lang.String getInstanceType()

The instance type of the EC2 instance.

Constraints:
Length: 1 - 255
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Returns:

The instance type of the EC2 instance.

setInstanceType

public void setInstanceType(java.lang.String instanceType)

The instance type of the EC2 instance.

Constraints:
Length: 1 - 255
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

instanceType -

The instance type of the EC2 instance.

withInstanceType

public Instance withInstanceType(java.lang.String instanceType)

The instance type of the EC2 instance.

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

Constraints:
Length: 1 - 255
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

instanceType -

The instance type of the EC2 instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getAvailabilityZone

public java.lang.String getAvailabilityZone()

The Availability Zone in which the instance is running.

Constraints:
Length: 1 - 255
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Returns:

The Availability Zone in which the instance is running.

setAvailabilityZone

public void setAvailabilityZone(java.lang.String availabilityZone)

The Availability Zone in which the instance is running.

Constraints:
Length: 1 - 255
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

availabilityZone -

The Availability Zone in which the instance is running.

withAvailabilityZone

public Instance withAvailabilityZone(java.lang.String availabilityZone)

The Availability Zone in which the instance is running.

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

Constraints:
Length: 1 - 255
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

availabilityZone -

The Availability Zone in which the instance is running.

Returns:

A reference to this updated object so that method calls can be chained together.

getLifecycleState

public java.lang.String getLifecycleState()

A description of the current lifecycle state. The Quarantined state is not used.

Constraints:
Allowed Values: Pending, Pending:Wait, Pending:Proceed, Quarantined, InService, Terminating, Terminating:Wait, Terminating:Proceed, Terminated, Detaching, Detached, EnteringStandby, Standby

Returns:

A description of the current lifecycle state. The Quarantined state is not used.

See Also:

LifecycleState

setLifecycleState

public void setLifecycleState(java.lang.String lifecycleState)

A description of the current lifecycle state. The Quarantined state is not used.

Constraints:
Allowed Values: Pending, Pending:Wait, Pending:Proceed, Quarantined, InService, Terminating, Terminating:Wait, Terminating:Proceed, Terminated, Detaching, Detached, EnteringStandby, Standby

Parameters:

lifecycleState -

A description of the current lifecycle state. The Quarantined state is not used.

See Also:

LifecycleState

withLifecycleState

public Instance withLifecycleState(java.lang.String lifecycleState)

A description of the current lifecycle state. The Quarantined state is not used.

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

Constraints:
Allowed Values: Pending, Pending:Wait, Pending:Proceed, Quarantined, InService, Terminating, Terminating:Wait, Terminating:Proceed, Terminated, Detaching, Detached, EnteringStandby, Standby

Parameters:

lifecycleState -

A description of the current lifecycle state. The Quarantined state is not used.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LifecycleState

setLifecycleState

public void setLifecycleState(LifecycleState lifecycleState)

A description of the current lifecycle state. The Quarantined state is not used.

Constraints:
Allowed Values: Pending, Pending:Wait, Pending:Proceed, Quarantined, InService, Terminating, Terminating:Wait, Terminating:Proceed, Terminated, Detaching, Detached, EnteringStandby, Standby

Parameters:

lifecycleState -

A description of the current lifecycle state. The Quarantined state is not used.

See Also:

LifecycleState

withLifecycleState

public Instance withLifecycleState(LifecycleState lifecycleState)

A description of the current lifecycle state. The Quarantined state is not used.

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

Constraints:
Allowed Values: Pending, Pending:Wait, Pending:Proceed, Quarantined, InService, Terminating, Terminating:Wait, Terminating:Proceed, Terminated, Detaching, Detached, EnteringStandby, Standby

Parameters:

lifecycleState -

A description of the current lifecycle state. The Quarantined state is not used.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LifecycleState

getHealthStatus

public java.lang.String getHealthStatus()

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

Constraints:
Length: 1 - 32
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Returns:

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

setHealthStatus

public void setHealthStatus(java.lang.String healthStatus)

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

Constraints:
Length: 1 - 32
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

healthStatus -

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

withHealthStatus

public Instance withHealthStatus(java.lang.String healthStatus)

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

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

Constraints:
Length: 1 - 32
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

healthStatus -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getLaunchConfigurationName

public java.lang.String getLaunchConfigurationName()

The launch configuration associated with the instance.

Constraints:
Length: 1 - 255
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Returns:

The launch configuration associated with the instance.

setLaunchConfigurationName

public void setLaunchConfigurationName(java.lang.String launchConfigurationName)

The launch configuration associated with the instance.

Constraints:
Length: 1 - 255
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

launchConfigurationName -

The launch configuration associated with the instance.

withLaunchConfigurationName

public Instance withLaunchConfigurationName(java.lang.String launchConfigurationName)

The launch configuration associated with the instance.

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

Constraints:
Length: 1 - 255
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

launchConfigurationName -

The launch configuration associated with the instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getLaunchTemplate

public LaunchTemplateSpecification getLaunchTemplate()

The launch template for the instance.

Returns:

The launch template for the instance.

setLaunchTemplate

public void setLaunchTemplate(LaunchTemplateSpecification launchTemplate)

The launch template for the instance.

Parameters:

launchTemplate -

The launch template for the instance.

withLaunchTemplate

public Instance withLaunchTemplate(LaunchTemplateSpecification launchTemplate)

The launch template for the instance.

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

Parameters:

launchTemplate -

The launch template for the instance.

Returns:

A reference to this updated object so that method calls can be chained together.

isProtectedFromScaleIn

public java.lang.Boolean isProtectedFromScaleIn()

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

Returns:

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

getProtectedFromScaleIn

public java.lang.Boolean getProtectedFromScaleIn()

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

Returns:

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

setProtectedFromScaleIn

public void setProtectedFromScaleIn(java.lang.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.

withProtectedFromScaleIn

public Instance withProtectedFromScaleIn(java.lang.Boolean protectedFromScaleIn)

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

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

Parameters:

protectedFromScaleIn -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getWeightedCapacity

public java.lang.String getWeightedCapacity()

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

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

Constraints:
Length: 1 - 32
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Returns:

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

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

setWeightedCapacity

public void setWeightedCapacity(java.lang.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.

Constraints:
Length: 1 - 32
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

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.

withWeightedCapacity

public Instance withWeightedCapacity(java.lang.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.

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

Constraints:
Length: 1 - 32
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

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:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object