EC2 / Client / enable_instance_sql_ha_standby_detections

enable_instance_sql_ha_standby_detections

EC2.Client.enable_instance_sql_ha_standby_detections(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.enable_instance_sql_ha_standby_detections(
    InstanceIds=[
        'string',
    ],
    SqlServerCredentials='string',
    DryRun=True|False
)
Parameters:

  • InstanceIds (list) –

    [REQUIRED]

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

    • (string) –

  • SqlServerCredentials (string) – 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 (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Instances': [
        {
            'InstanceId': 'string',
            'SqlServerLicenseUsage': 'full'|'waived',
            'HaStatus': 'processing'|'active'|'standby'|'invalid',
            'ProcessingStatus': 'string',
            'LastUpdatedTime': datetime(2015, 1, 1),
            'SqlServerCredentials': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • Instances (list) –

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

      • (dict) –

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

        • InstanceId (string) –

          The ID of the SQL Server High Availability instance.

        • SqlServerLicenseUsage (string) –

          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.

        • HaStatus (string) –

          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.

        • ProcessingStatus (string) –

          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.

        • LastUpdatedTime (datetime) –

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

        • SqlServerCredentials (string) –

          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.

        • Tags (list) –

          The tags assigned to the SQL Server High Availability instance.

          • (dict) –

            Describes a tag.

            • Key (string) –

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

            • Value (string) –

              The value of the tag.

              Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.