Skip to content

Enable Instance Sql Ha Standby Detections

ec2_enable_instance_sql_ha_standby_detections R Documentation

Enable Amazon EC2 instances running in an SQL Server High Availability cluster for SQL Server High Availability instance standby detection monitoring

Description

Enable Amazon EC2 instances running in an SQL Server High Availability cluster for SQL Server High Availability instance standby detection monitoring. Once enabled, Amazon Web Services 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, Amazon Web Services 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 Amazon Web Services 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.

Usage

ec2_enable_instance_sql_ha_standby_detections(InstanceIds,
  SqlServerCredentials, DryRun)

Arguments

InstanceIds

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

The ARN of the 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 Amazon Web Services Systems Manager agent. To enable instances with different credentials, you must make separate requests.
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.

Value

A list with the following syntax:

list(
  Instances = list(
    list(
      InstanceId = "string",
      SqlServerLicenseUsage = "full"|"waived",
      HaStatus = "processing"|"active"|"standby"|"invalid",
      ProcessingStatus = "string",
      LastUpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      SqlServerCredentials = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  )
)

Request syntax

svc$enable_instance_sql_ha_standby_detections(
  InstanceIds = list(
    "string"
  ),
  SqlServerCredentials = "string",
  DryRun = TRUE|FALSE
)