Skip to content

/AWS1/CL_EC2REGISTEREDINSTANCE

Describes an Amazon EC2 instance that is enabled for SQL Server High Availability standby detection monitoring.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_instanceid TYPE /AWS1/EC2INSTANCEID /AWS1/EC2INSTANCEID

The ID of the SQL Server High Availability instance.

iv_sqlserverlicenseusage TYPE /AWS1/EC2SQLSERVERLICENSEUSAGE /AWS1/EC2SQLSERVERLICENSEUSAGE

The license type for the SQL Server license. Valid values include:

  • full - The SQL Server High Availability instance is using a full SQL Server license.

  • waived - The SQL Server High Availability instance is waived from the SQL Server license.

iv_hastatus TYPE /AWS1/EC2HASTATUS /AWS1/EC2HASTATUS

The SQL Server High Availability status of the instance. Valid values are:

  • processing - The SQL Server High Availability status for the SQL Server High Availability instance is being updated.

  • active - The SQL Server High Availability instance is an active node in an SQL Server High Availability cluster.

  • standby - The SQL Server High Availability instance is a standby failover node in an SQL Server High Availability cluster.

  • invalid - An error occurred due to misconfigured permissions, or unable to dertemine SQL Server High Availability status for the SQL Server High Availability instance.

iv_processingstatus TYPE /AWS1/EC2STRING /AWS1/EC2STRING

A brief description of the SQL Server High Availability status. If the instance is in the invalid High Availability status, this parameter includes the error message.

iv_lastupdatedtime TYPE /AWS1/EC2MILLISECONDDATETIME /AWS1/EC2MILLISECONDDATETIME

The date and time when the instance's SQL Server High Availability status was last updated, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).

iv_sqlservercredentials TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The ARN of the Secrets Manager secret containing the SQL Server access credentials for the SQL Server High Availability instance. If not specified, deafult local user credentials will be used by the Amazon Web Services Systems Manager agent.

it_tags TYPE /AWS1/CL_EC2TAG=>TT_TAGLIST TT_TAGLIST

The tags assigned to the SQL Server High Availability instance.

Queryable Attributes

InstanceId

The ID of the SQL Server High Availability 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

SqlServerLicenseUsage

The license type for the SQL Server license. Valid values include:

  • full - The SQL Server High Availability instance is using a full SQL Server license.

  • waived - The SQL Server High Availability instance is waived from the SQL Server license.

Accessible with the following methods

Method Description
GET_SQLSERVERLICENSEUSAGE() Getter for SQLSERVERLICENSEUSAGE, with configurable default
ASK_SQLSERVERLICENSEUSAGE() Getter for SQLSERVERLICENSEUSAGE w/ exceptions if field has
HAS_SQLSERVERLICENSEUSAGE() Determine if SQLSERVERLICENSEUSAGE has a value

HaStatus

The SQL Server High Availability status of the instance. Valid values are:

  • processing - The SQL Server High Availability status for the SQL Server High Availability instance is being updated.

  • active - The SQL Server High Availability instance is an active node in an SQL Server High Availability cluster.

  • standby - The SQL Server High Availability instance is a standby failover node in an SQL Server High Availability cluster.

  • invalid - An error occurred due to misconfigured permissions, or unable to dertemine SQL Server High Availability status for the SQL Server High Availability instance.

Accessible with the following methods

Method Description
GET_HASTATUS() Getter for HASTATUS, with configurable default
ASK_HASTATUS() Getter for HASTATUS w/ exceptions if field has no value
HAS_HASTATUS() Determine if HASTATUS has a value

ProcessingStatus

A brief description of the SQL Server High Availability status. If the instance is in the invalid High Availability status, this parameter includes the error message.

Accessible with the following methods

Method Description
GET_PROCESSINGSTATUS() Getter for PROCESSINGSTATUS, with configurable default
ASK_PROCESSINGSTATUS() Getter for PROCESSINGSTATUS w/ exceptions if field has no va
HAS_PROCESSINGSTATUS() Determine if PROCESSINGSTATUS has a value

LastUpdatedTime

The date and time when the instance's SQL Server High Availability status was last updated, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).

Accessible with the following methods

Method Description
GET_LASTUPDATEDTIME() Getter for LASTUPDATEDTIME, with configurable default
ASK_LASTUPDATEDTIME() Getter for LASTUPDATEDTIME w/ exceptions if field has no val
HAS_LASTUPDATEDTIME() Determine if LASTUPDATEDTIME has a value

SqlServerCredentials

The ARN of the Secrets Manager secret containing the SQL Server access credentials for the SQL Server High Availability instance. If not specified, deafult local user credentials will be used by the Amazon Web Services Systems Manager agent.

Accessible with the following methods

Method Description
GET_SQLSERVERCREDENTIALS() Getter for SQLSERVERCREDENTIALS, with configurable default
ASK_SQLSERVERCREDENTIALS() Getter for SQLSERVERCREDENTIALS w/ exceptions if field has n
HAS_SQLSERVERCREDENTIALS() Determine if SQLSERVERCREDENTIALS has a value

Tags

The tags assigned to the SQL Server High Availability instance.

Accessible with the following methods

Method Description
GET_TAGS() Getter for TAGS, with configurable default
ASK_TAGS() Getter for TAGS w/ exceptions if field has no value
HAS_TAGS() Determine if TAGS 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_REGISTEREDINSTANCELIST

TYPES TT_REGISTEREDINSTANCELIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_EC2REGISTEREDINSTANCE WITH DEFAULT KEY
.