Share via

InstanceFailoverGroup Class

An instance failover group.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

InstanceFailoverGroup(*, read_write_endpoint: InstanceFailoverGroupReadWriteEndpoint | None = None, read_only_endpoint: InstanceFailoverGroupReadOnlyEndpoint | None = None, partner_regions: List[PartnerRegionInfo] | None = None, managed_instance_pairs: List[ManagedInstancePairInfo] | None = None, **kwargs)

Parameters

Name Description
read_write_endpoint
Required
InstanceFailoverGroupReadWriteEndpoint

Read-write endpoint of the failover group instance.
read_only_endpoint
Required
InstanceFailoverGroupReadOnlyEndpoint

Read-only endpoint of the failover group instance.
partner_regions
Required
list[PartnerRegionInfo]

Partner region information for the failover group.
managed_instance_pairs
Required
list[ManagedInstancePairInfo]

List of managed instance pairs in the failover group.

Keyword-Only Parameters

Name Description
read_write_endpoint
Default value: None
read_only_endpoint
Default value: None
partner_regions
Default value: None
managed_instance_pairs
Default value: None

Variables

Name Description
id
str

Resource ID.
name
str

Resource name.
type
str

Resource type.
replication_role
str or InstanceFailoverGroupReplicationRole

Local replication role of the failover group instance. Possible values include: "Primary", "Secondary".
replication_state
str

Replication state of the failover group instance.