Skip to content

RegisteredInstance

Source code in docs_src/capo_ec2/types/registered_instance.py
class RegisteredInstance(TypedDict, closed=True):
    instance_id: NotRequired["capo_ec2.types.instance_id.InstanceId"]
    """<p>The ID of the SQL Server High Availability instance.</p>"""
    sql_server_license_usage: NotRequired[
        "capo_ec2.types.sql_server_license_usage.SqlServerLicenseUsage"
    ]
    """<p>The license type for the SQL Server license. Valid values include:</p> <ul> <li> <p> <code>full</code> - The SQL Server High Availability instance is using a full SQL Server license.</p> </li> <li> <p> <code>waived</code> - The SQL Server High Availability instance is waived from the SQL Server license.</p> </li> </ul>"""
    ha_status: NotRequired["capo_ec2.types.ha_status.HaStatus"]
    """<p>The SQL Server High Availability status of the instance. Valid values are:</p> <ul> <li> <p> <code>processing</code> - The SQL Server High Availability status for the SQL Server High Availability instance is being updated.</p> </li> <li> <p> <code>active</code> - The SQL Server High Availability instance is an active node in an SQL Server High Availability cluster.</p> </li> <li> <p> <code>standby</code> - The SQL Server High Availability instance is a standby failover node in an SQL Server High Availability cluster.</p> </li> <li> <p> <code>invalid</code> - An error occurred due to misconfigured permissions, or unable to dertemine SQL Server High Availability status for the SQL Server High Availability instance.</p> </li> </ul>"""
    processing_status: NotRequired["capo_ec2.types.string.String"]
    """<p>A brief description of the SQL Server High Availability status. If the instance is in the <code>invalid</code> High Availability status, this parameter includes the error message.</p>"""
    last_updated_time: NotRequired[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ]
    """<p>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 (<code>YYYY-MM-DDThh:mm:ss.sssZ</code>).</p>"""
    sql_server_credentials: NotRequired["capo_ec2.types.string.String"]
    """<p>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.</p>"""
    tags: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<p>The tags assigned to the SQL Server High Availability instance.</p>"""

ha_status instance-attribute

ha_status: NotRequired[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.

instance_id instance-attribute

instance_id: NotRequired[InstanceId]

The ID of the SQL Server High Availability instance.

last_updated_time instance-attribute

last_updated_time: NotRequired[MillisecondDateTime]

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

processing_status instance-attribute

processing_status: NotRequired[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.

sql_server_credentials instance-attribute

sql_server_credentials: NotRequired[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.

sql_server_license_usage instance-attribute

sql_server_license_usage: NotRequired[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.

tags instance-attribute

tags: NotRequired[TagList]

The tags assigned to the SQL Server High Availability instance.