amazonka-autoscaling-2.0: Amazon Auto Scaling SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AutoScaling.Types.AutoScalingInstanceDetails

Description

 
Synopsis

Documentation

data AutoScalingInstanceDetails Source #

Describes an EC2 instance associated with an Auto Scaling group.

See: newAutoScalingInstanceDetails smart constructor.

Constructors

AutoScalingInstanceDetails' 

Fields

  • instanceType :: Maybe Text

    The instance type of the EC2 instance.

  • launchConfigurationName :: Maybe Text

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

  • launchTemplate :: Maybe LaunchTemplateSpecification

    The launch template for the instance.

  • weightedCapacity :: Maybe Text

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

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

  • instanceId :: Text

    The ID of the instance.

  • autoScalingGroupName :: Text

    The name of the Auto Scaling group for the instance.

  • availabilityZone :: Text

    The Availability Zone for the instance.

  • lifecycleState :: Text

    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

  • healthStatus :: Text

    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.

  • protectedFromScaleIn :: Bool

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

Instances

Instances details
FromXML AutoScalingInstanceDetails Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.AutoScalingInstanceDetails

Generic AutoScalingInstanceDetails Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.AutoScalingInstanceDetails

Associated Types

type Rep AutoScalingInstanceDetails :: Type -> Type #

Read AutoScalingInstanceDetails Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.AutoScalingInstanceDetails

Show AutoScalingInstanceDetails Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.AutoScalingInstanceDetails

NFData AutoScalingInstanceDetails Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.AutoScalingInstanceDetails

Eq AutoScalingInstanceDetails Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.AutoScalingInstanceDetails

Hashable AutoScalingInstanceDetails Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.AutoScalingInstanceDetails

type Rep AutoScalingInstanceDetails Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.AutoScalingInstanceDetails

type Rep AutoScalingInstanceDetails = D1 ('MetaData "AutoScalingInstanceDetails" "Amazonka.AutoScaling.Types.AutoScalingInstanceDetails" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "AutoScalingInstanceDetails'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "launchConfigurationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "launchTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchTemplateSpecification)) :*: (S1 ('MetaSel ('Just "weightedCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :*: ((S1 ('MetaSel ('Just "autoScalingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "lifecycleState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "healthStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "protectedFromScaleIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))))

newAutoScalingInstanceDetails Source #

Create a value of AutoScalingInstanceDetails with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:instanceType:AutoScalingInstanceDetails', autoScalingInstanceDetails_instanceType - The instance type of the EC2 instance.

$sel:launchConfigurationName:AutoScalingInstanceDetails', autoScalingInstanceDetails_launchConfigurationName - The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.

$sel:launchTemplate:AutoScalingInstanceDetails', autoScalingInstanceDetails_launchTemplate - The launch template for the instance.

$sel:weightedCapacity:AutoScalingInstanceDetails', autoScalingInstanceDetails_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.

$sel:instanceId:AutoScalingInstanceDetails', autoScalingInstanceDetails_instanceId - The ID of the instance.

$sel:autoScalingGroupName:AutoScalingInstanceDetails', autoScalingInstanceDetails_autoScalingGroupName - The name of the Auto Scaling group for the instance.

$sel:availabilityZone:AutoScalingInstanceDetails', autoScalingInstanceDetails_availabilityZone - The Availability Zone for the instance.

$sel:lifecycleState:AutoScalingInstanceDetails', autoScalingInstanceDetails_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

$sel:healthStatus:AutoScalingInstanceDetails', autoScalingInstanceDetails_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.

$sel:protectedFromScaleIn:AutoScalingInstanceDetails', autoScalingInstanceDetails_protectedFromScaleIn - Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

autoScalingInstanceDetails_launchConfigurationName :: Lens' AutoScalingInstanceDetails (Maybe Text) Source #

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

autoScalingInstanceDetails_weightedCapacity :: Lens' AutoScalingInstanceDetails (Maybe Text) Source #

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

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

autoScalingInstanceDetails_autoScalingGroupName :: Lens' AutoScalingInstanceDetails Text Source #

The name of the Auto Scaling group for the instance.

autoScalingInstanceDetails_lifecycleState :: Lens' AutoScalingInstanceDetails Text Source #

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

autoScalingInstanceDetails_healthStatus :: Lens' AutoScalingInstanceDetails Text Source #

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.

autoScalingInstanceDetails_protectedFromScaleIn :: Lens' AutoScalingInstanceDetails Bool Source #

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