Skip to content

/AWS1/CL_SGMINSTANCEMETADATA

Metadata information about an instance in a HyperPod cluster.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_customereni TYPE /AWS1/SGMSTRING00 /AWS1/SGMSTRING00

The ID of the customer-managed Elastic Network Interface (ENI) associated with the instance.

io_additionalenis TYPE REF TO /AWS1/CL_SGMADDITIONALENIS /AWS1/CL_SGMADDITIONALENIS

Information about additional Elastic Network Interfaces (ENIs) associated with the instance.

io_capacityreservation TYPE REF TO /AWS1/CL_SGMCAPACITYRESV /AWS1/CL_SGMCAPACITYRESV

Information about the Capacity Reservation used by the instance.

iv_failuremessage TYPE /AWS1/SGMSTRING00 /AWS1/SGMSTRING00

An error message describing why the instance creation or update failed, if applicable.

iv_lcsexecutionstate TYPE /AWS1/SGMSTRING00 /AWS1/SGMSTRING00

The execution state of the Lifecycle Script (LCS) for the instance.

iv_nodelogicalid TYPE /AWS1/SGMCLUSTERNODELOGICALID /AWS1/SGMCLUSTERNODELOGICALID

The unique logical identifier of the node within the cluster. The ID used here is the same object as in the BatchAddClusterNodes API.


Queryable Attributes

CustomerEni

The ID of the customer-managed Elastic Network Interface (ENI) associated with the instance.

Accessible with the following methods

Method Description
GET_CUSTOMERENI() Getter for CUSTOMERENI, with configurable default
ASK_CUSTOMERENI() Getter for CUSTOMERENI w/ exceptions if field has no value
HAS_CUSTOMERENI() Determine if CUSTOMERENI has a value

AdditionalEnis

Information about additional Elastic Network Interfaces (ENIs) associated with the instance.

Accessible with the following methods

Method Description
GET_ADDITIONALENIS() Getter for ADDITIONALENIS

CapacityReservation

Information about the Capacity Reservation used by the instance.

Accessible with the following methods

Method Description
GET_CAPACITYRESERVATION() Getter for CAPACITYRESERVATION

FailureMessage

An error message describing why the instance creation or update failed, if applicable.

Accessible with the following methods

Method Description
GET_FAILUREMESSAGE() Getter for FAILUREMESSAGE, with configurable default
ASK_FAILUREMESSAGE() Getter for FAILUREMESSAGE w/ exceptions if field has no valu
HAS_FAILUREMESSAGE() Determine if FAILUREMESSAGE has a value

LcsExecutionState

The execution state of the Lifecycle Script (LCS) for the instance.

Accessible with the following methods

Method Description
GET_LCSEXECUTIONSTATE() Getter for LCSEXECUTIONSTATE, with configurable default
ASK_LCSEXECUTIONSTATE() Getter for LCSEXECUTIONSTATE w/ exceptions if field has no v
HAS_LCSEXECUTIONSTATE() Determine if LCSEXECUTIONSTATE has a value

NodeLogicalId

The unique logical identifier of the node within the cluster. The ID used here is the same object as in the BatchAddClusterNodes API.

Accessible with the following methods

Method Description
GET_NODELOGICALID() Getter for NODELOGICALID, with configurable default
ASK_NODELOGICALID() Getter for NODELOGICALID w/ exceptions if field has no value
HAS_NODELOGICALID() Determine if NODELOGICALID has a value