Skip to content

/AWS1/CL_ASCINSTANCE

Describes an EC2 instance.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_instanceid TYPE /AWS1/ASCXMLSTRINGMAXLEN19 /AWS1/ASCXMLSTRINGMAXLEN19

The ID of the instance.

iv_availabilityzone TYPE /AWS1/ASCXMLSTRINGMAXLEN255 /AWS1/ASCXMLSTRINGMAXLEN255

The Availability Zone in which the instance is running.

iv_lifecyclestate TYPE /AWS1/ASCLIFECYCLESTATE /AWS1/ASCLIFECYCLESTATE

A description of the current lifecycle state. The Quarantined state is not used. For more information, see Amazon EC2 Auto Scaling instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

iv_healthstatus TYPE /AWS1/ASCXMLSTRINGMAXLEN32 /AWS1/ASCXMLSTRINGMAXLEN32

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.

iv_protectedfromscalein TYPE /AWS1/ASCINSTANCEPROTECTED /AWS1/ASCINSTANCEPROTECTED

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

Optional arguments:

iv_instancetype TYPE /AWS1/ASCXMLSTRINGMAXLEN255 /AWS1/ASCXMLSTRINGMAXLEN255

The instance type of the EC2 instance.

iv_launchconfigurationname TYPE /AWS1/ASCXMLSTRINGMAXLEN255 /AWS1/ASCXMLSTRINGMAXLEN255

The launch configuration associated with the instance.

io_launchtemplate TYPE REF TO /AWS1/CL_ASCLAUNCHTEMPLATESPEC /AWS1/CL_ASCLAUNCHTEMPLATESPEC

The launch template for the instance.

iv_imageid TYPE /AWS1/ASCXMLSTRINGMAXLEN255 /AWS1/ASCXMLSTRINGMAXLEN255

The ID of the Amazon Machine Image (AMI) used for the instance's current root volume. This value reflects the most recent AMI applied to the instance, including updates made through root volume replacement operations.

This field appears for:

  • Instances with root volume replacements through Instance Refresh

  • Instances launched with AMI overrides

This field won't appear for:

  • Existing instances launched from Launch Templates without overrides

  • Existing instances that didn’t have their root volume replaced through Instance Refresh

iv_weightedcapacity TYPE /AWS1/ASCXMLSTRINGMAXLEN32 /AWS1/ASCXMLSTRINGMAXLEN32

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

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

Queryable Attributes

InstanceId

The ID of the instance.

Accessible with the following methods

Method Description
GET_INSTANCEID() Getter for INSTANCEID, with configurable default
ASK_INSTANCEID() Getter for INSTANCEID w/ exceptions if field has no value
HAS_INSTANCEID() Determine if INSTANCEID has a value

InstanceType

The instance type of the EC2 instance.

Accessible with the following methods

Method Description
GET_INSTANCETYPE() Getter for INSTANCETYPE, with configurable default
ASK_INSTANCETYPE() Getter for INSTANCETYPE w/ exceptions if field has no value
HAS_INSTANCETYPE() Determine if INSTANCETYPE has a value

AvailabilityZone

The Availability Zone in which the instance is running.

Accessible with the following methods

Method Description
GET_AVAILABILITYZONE() Getter for AVAILABILITYZONE, with configurable default
ASK_AVAILABILITYZONE() Getter for AVAILABILITYZONE w/ exceptions if field has no va
HAS_AVAILABILITYZONE() Determine if AVAILABILITYZONE has a value

LifecycleState

A description of the current lifecycle state. The Quarantined state is not used. For more information, see Amazon EC2 Auto Scaling instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

Accessible with the following methods

Method Description
GET_LIFECYCLESTATE() Getter for LIFECYCLESTATE, with configurable default
ASK_LIFECYCLESTATE() Getter for LIFECYCLESTATE w/ exceptions if field has no valu
HAS_LIFECYCLESTATE() Determine if LIFECYCLESTATE has a value

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.

Accessible with the following methods

Method Description
GET_HEALTHSTATUS() Getter for HEALTHSTATUS, with configurable default
ASK_HEALTHSTATUS() Getter for HEALTHSTATUS w/ exceptions if field has no value
HAS_HEALTHSTATUS() Determine if HEALTHSTATUS has a value

LaunchConfigurationName

The launch configuration associated with the instance.

Accessible with the following methods

Method Description
GET_LAUNCHCONFIGURATIONNAME() Getter for LAUNCHCONFIGURATIONNAME, with configurable defaul
ASK_LAUNCHCONFIGURATIONNAME() Getter for LAUNCHCONFIGURATIONNAME w/ exceptions if field ha
HAS_LAUNCHCONFIGURATIONNAME() Determine if LAUNCHCONFIGURATIONNAME has a value

LaunchTemplate

The launch template for the instance.

Accessible with the following methods

Method Description
GET_LAUNCHTEMPLATE() Getter for LAUNCHTEMPLATE

ImageId

The ID of the Amazon Machine Image (AMI) used for the instance's current root volume. This value reflects the most recent AMI applied to the instance, including updates made through root volume replacement operations.

This field appears for:

  • Instances with root volume replacements through Instance Refresh

  • Instances launched with AMI overrides

This field won't appear for:

  • Existing instances launched from Launch Templates without overrides

  • Existing instances that didn’t have their root volume replaced through Instance Refresh

Accessible with the following methods

Method Description
GET_IMAGEID() Getter for IMAGEID, with configurable default
ASK_IMAGEID() Getter for IMAGEID w/ exceptions if field has no value
HAS_IMAGEID() Determine if IMAGEID has a value

ProtectedFromScaleIn

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

Accessible with the following methods

Method Description
GET_PROTECTEDFROMSCALEIN() Getter for PROTECTEDFROMSCALEIN, with configurable default
ASK_PROTECTEDFROMSCALEIN() Getter for PROTECTEDFROMSCALEIN w/ exceptions if field has n
HAS_PROTECTEDFROMSCALEIN() Determine if PROTECTEDFROMSCALEIN has a value

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.

Accessible with the following methods

Method Description
GET_WEIGHTEDCAPACITY() Getter for WEIGHTEDCAPACITY, with configurable default
ASK_WEIGHTEDCAPACITY() Getter for WEIGHTEDCAPACITY w/ exceptions if field has no va
HAS_WEIGHTEDCAPACITY() Determine if WEIGHTEDCAPACITY has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_INSTANCES

TYPES TT_INSTANCES TYPE STANDARD TABLE OF REF TO /AWS1/CL_ASCINSTANCE WITH DEFAULT KEY
.