RegisteredInstance - Amazon Elastic Compute Cloud
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

RegisteredInstance

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

Contents

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.

Type: String

Valid Values: processing | active | standby | invalid

Required: No

instanceId

The ID of the SQL Server High Availability instance.

Type: String

Required: No

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).

Type: Timestamp

Required: No

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.

Type: String

Required: No

sqlServerCredentials

The ARN of the Amazon 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 Systems Manager agent.

Type: String

Required: No

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.

Type: String

Valid Values: full | waived

Required: No

tagSet

The tags assigned to the SQL Server High Availability instance.

Type: Array of Tag objects

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: