Skip to content

Connector

Source code in docs_src/capo_evs/types/connector.py
class Connector(TypedDict, closed=True):
    environment_id: NotRequired["capo_evs.types.environment_id.EnvironmentId"]
    """<p>The unique ID of the environment that the connector belongs to.</p>"""
    connector_id: NotRequired["capo_evs.types.connector_id.ConnectorId"]
    """<p>The unique ID of the connector.</p>"""
    type: NotRequired["capo_evs.types.connector_type.ConnectorType"]
    """<p>The type of the connector.</p>"""
    appliance_fqdn: NotRequired["capo_evs.types.appliance_fqdn.ApplianceFqdn"]
    """<p>The fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.</p>"""
    secret_arn: NotRequired["capo_evs.types.secret_identifier.SecretIdentifier"]
    """<p>The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.</p>"""
    state: NotRequired["capo_evs.types.connector_state.ConnectorState"]
    """<p>The state of the connector.</p>"""
    state_details: NotRequired["capo_evs.types.state_details.StateDetails"]
    """<p>A detailed description of the connector state.</p>"""
    status: NotRequired["capo_evs.types.check_result.CheckResult"]
    """<p>The status of the connector.</p>"""
    checks: NotRequired["capo_evs.types.connectors_checks_list.ConnectorsChecksList"]
    """<p>A list of checks that are run on the connector.</p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>The date and time that the connector was created.</p>"""
    modified_at: NotRequired["datetime.datetime"]
    """<p>The date and time that the connector was modified.</p>"""

appliance_fqdn instance-attribute

appliance_fqdn: NotRequired[ApplianceFqdn]

The fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.

checks instance-attribute

checks: NotRequired[ConnectorsChecksList]

A list of checks that are run on the connector.

connector_id instance-attribute

connector_id: NotRequired[ConnectorId]

The unique ID of the connector.

created_at instance-attribute

created_at: NotRequired[datetime]

The date and time that the connector was created.

environment_id instance-attribute

environment_id: NotRequired[EnvironmentId]

The unique ID of the environment that the connector belongs to.

modified_at instance-attribute

modified_at: NotRequired[datetime]

The date and time that the connector was modified.

secret_arn instance-attribute

secret_arn: NotRequired[SecretIdentifier]

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.

state instance-attribute

state: NotRequired[ConnectorState]

The state of the connector.

state_details instance-attribute

state_details: NotRequired[StateDetails]

A detailed description of the connector state.

status instance-attribute

status: NotRequired[CheckResult]

The status of the connector.

type instance-attribute

type: NotRequired[ConnectorType]

The type of the connector.