Request Parameters Response Elements Errors See Also

EnableInstanceSqlHaStandbyDetections

Enable Amazon EC2 instances running in an SQL Server High Availability cluster for SQL Server High Availability instance standby detection monitoring. Once enabled, AWS monitors the metadata for the instances to determine whether they are active or standby nodes in the SQL Server High Availability cluster. If the instances are determined to be standby failover nodes, AWS automatically applies SQL Server licensing fee waiver for those instances.

To register an instance, it must be running a Windows SQL Server license-included AMI and have the AWS Systems Manager agent installed and running. Only Windows Server 2019 and later and SQL Server (Standard and Enterprise editions) 2017 and later are supported. For more information, see Prerequisites for using SQL Server High Availability instance standby detection.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

InstanceId.N

The IDs of the instances to enable for SQL Server High Availability standby detection monitoring.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 30 items.

Required: Yes

SqlServerCredentials

The ARN of the AWS Secrets Manager secret containing the SQL Server access credentials. The specified secret must contain valid SQL Server credentials for the specified instances. If not specified, deafult local user credentials will be used by the AWS Systems Manager agent. To enable instances with different credentials, you must make separate requests.

Type: String

Pattern: ^(?=.{20,2048}$)arn:aws[a-z-]*:secretsmanager:[a-z0-9-]+:\d{12}:secret:[a-zA-Z0-9/_+=.@-]+

Required: No

Response Elements

The following elements are returned by the service.

instanceSet

Information about the instances that were enabled for SQL Server High Availability standby detection monitoring.

Type: Array of RegisteredInstance objects

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.