enable_instance_sql_ha_standby_detections¶
Operation¶
async
¶
enable_instance_sql_ha_standby_detections(input: EnableInstanceSqlHaStandbyDetectionsInput, plugins: list[Plugin] | None = None) -> EnableInstanceSqlHaStandbyDetectionsOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
EnableInstanceSqlHaStandbyDetectionsInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
EnableInstanceSqlHaStandbyDetectionsOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for EnableInstanceSqlHaStandbyDetectionsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
class-attribute
instance-attribute
¶
The IDs of the instances to enable for SQL Server High Availability standby detection monitoring.
class-attribute
instance-attribute
¶
sql_server_credentials: str | None = ...
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for EnableInstanceSqlHaStandbyDetectionsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
instances: list[RegisteredInstance] | None = ...
Information about the instances that were enabled for SQL Server High Availability standby detection monitoring.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.