Skip to content

ConnectorConfiguration

Source code in docs_src/capo_appflow/types/connector_configuration.py
class ConnectorConfiguration(TypedDict, closed=True):
    can_use_as_source: "capo_appflow.types.boolean.Boolean"
    """<p> Specifies whether the connector can be used as a source. </p>"""
    can_use_as_destination: "capo_appflow.types.boolean.Boolean"
    """<p> Specifies whether the connector can be used as a destination. </p>"""
    supported_destination_connectors: NotRequired[
        "capo_appflow.types.connector_type_list.ConnectorTypeList"
    ]
    """<p> Lists the connectors that are available for use as destinations. </p>"""
    supported_scheduling_frequencies: NotRequired[
        "capo_appflow.types.scheduling_frequency_type_list.SchedulingFrequencyTypeList"
    ]
    """<p> Specifies the supported flow frequency for that connector. </p>"""
    is_private_link_enabled: "capo_appflow.types.boolean.Boolean"
    """<p> Specifies if PrivateLink is enabled for that connector. </p>"""
    is_private_link_endpoint_url_required: "capo_appflow.types.boolean.Boolean"
    """<p> Specifies if a PrivateLink endpoint URL is required. </p>"""
    supported_trigger_types: NotRequired[
        "capo_appflow.types.trigger_type_list.TriggerTypeList"
    ]
    """<p> Specifies the supported trigger types for the flow. </p>"""
    connector_metadata: NotRequired[
        "capo_appflow.types.connector_metadata.ConnectorMetadata"
    ]
    """<p> Specifies connector-specific metadata such as <code>oAuthScopes</code>, <code>supportedRegions</code>, <code>privateLinkServiceUrl</code>, and so on. </p>"""
    connector_type: NotRequired["capo_appflow.types.connector_type.ConnectorType"]
    """<p>The connector type.</p>"""
    connector_label: NotRequired["capo_appflow.types.connector_label.ConnectorLabel"]
    """<p>The label used for registering the connector.</p>"""
    connector_description: NotRequired[
        "capo_appflow.types.connector_description.ConnectorDescription"
    ]
    """<p>A description about the connector.</p>"""
    connector_owner: NotRequired["capo_appflow.types.connector_owner.ConnectorOwner"]
    """<p>The owner who developed the connector.</p>"""
    connector_name: NotRequired["capo_appflow.types.connector_name.ConnectorName"]
    """<p>The connector name.</p>"""
    connector_version: NotRequired[
        "capo_appflow.types.connector_version.ConnectorVersion"
    ]
    """<p>The connector version.</p>"""
    connector_arn: NotRequired["capo_appflow.types.arn.ARN"]
    """<p>The Amazon Resource Name (ARN) for the registered connector.</p>"""
    connector_modes: NotRequired[
        "capo_appflow.types.connector_mode_list.ConnectorModeList"
    ]
    """<p>The connection modes that the connector supports.</p>"""
    authentication_config: NotRequired[
        "capo_appflow.types.authentication_config.AuthenticationConfig"
    ]
    """<p>The authentication config required for the connector.</p>"""
    connector_runtime_settings: NotRequired[
        "capo_appflow.types.connector_runtime_setting_list.ConnectorRuntimeSettingList"
    ]
    """<p>The required connector runtime settings.</p>"""
    supported_api_versions: NotRequired[
        "capo_appflow.types.supported_api_version_list.SupportedApiVersionList"
    ]
    """<p>A list of API versions that are supported by the connector.</p>"""
    supported_operators: NotRequired[
        "capo_appflow.types.supported_operator_list.SupportedOperatorList"
    ]
    """<p>A list of operators supported by the connector.</p>"""
    supported_write_operations: NotRequired[
        "capo_appflow.types.supported_write_operation_list.SupportedWriteOperationList"
    ]
    """<p>A list of write operations supported by the connector.</p>"""
    connector_provisioning_type: NotRequired[
        "capo_appflow.types.connector_provisioning_type.ConnectorProvisioningType"
    ]
    """<p>The provisioning type used to register the connector.</p>"""
    connector_provisioning_config: NotRequired[
        "capo_appflow.types.connector_provisioning_config.ConnectorProvisioningConfig"
    ]
    """<p>The configuration required for registering the connector.</p>"""
    logo_url: NotRequired["capo_appflow.types.logo_url.LogoURL"]
    """<p>Logo URL of the connector.</p>"""
    registered_at: NotRequired["capo_appflow.types.date.Date"]
    """<p>The date on which the connector was registered.</p>"""
    registered_by: NotRequired["capo_appflow.types.registered_by.RegisteredBy"]
    """<p>Information about who registered the connector.</p>"""
    supported_data_transfer_types: NotRequired[
        "capo_appflow.types.supported_data_transfer_type_list.SupportedDataTransferTypeList"
    ]
    """<p>The data transfer types that the connector supports.</p> <dl> <dt>RECORD</dt> <dd> <p>Structured records.</p> </dd> <dt>FILE</dt> <dd> <p>Files or binary data.</p> </dd> </dl>"""
    supported_data_transfer_apis: NotRequired[
        "capo_appflow.types.supported_data_transfer_apis.SupportedDataTransferApis"
    ]
    """<p>The APIs of the connector application that Amazon AppFlow can use to transfer your data.</p>"""

authentication_config instance-attribute

authentication_config: NotRequired[AuthenticationConfig]

The authentication config required for the connector.

can_use_as_destination instance-attribute

can_use_as_destination: Boolean

Specifies whether the connector can be used as a destination.

can_use_as_source instance-attribute

can_use_as_source: Boolean

Specifies whether the connector can be used as a source.

connector_arn instance-attribute

connector_arn: NotRequired[ARN]

The Amazon Resource Name (ARN) for the registered connector.

connector_description instance-attribute

connector_description: NotRequired[ConnectorDescription]

A description about the connector.

connector_label instance-attribute

connector_label: NotRequired[ConnectorLabel]

The label used for registering the connector.

connector_metadata instance-attribute

connector_metadata: NotRequired[ConnectorMetadata]

Specifies connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.

connector_modes instance-attribute

connector_modes: NotRequired[ConnectorModeList]

The connection modes that the connector supports.

connector_name instance-attribute

connector_name: NotRequired[ConnectorName]

The connector name.

connector_owner instance-attribute

connector_owner: NotRequired[ConnectorOwner]

The owner who developed the connector.

connector_provisioning_config instance-attribute

connector_provisioning_config: NotRequired[ConnectorProvisioningConfig]

The configuration required for registering the connector.

connector_provisioning_type instance-attribute

connector_provisioning_type: NotRequired[ConnectorProvisioningType]

The provisioning type used to register the connector.

connector_runtime_settings instance-attribute

connector_runtime_settings: NotRequired[ConnectorRuntimeSettingList]

The required connector runtime settings.

connector_type instance-attribute

connector_type: NotRequired[ConnectorType]

The connector type.

connector_version instance-attribute

connector_version: NotRequired[ConnectorVersion]

The connector version.

is_private_link_enabled: Boolean

Specifies if PrivateLink is enabled for that connector.

is_private_link_endpoint_url_required: Boolean

Specifies if a PrivateLink endpoint URL is required.

logo_url instance-attribute

logo_url: NotRequired[LogoURL]

Logo URL of the connector.

registered_at instance-attribute

registered_at: NotRequired[Date]

The date on which the connector was registered.

registered_by instance-attribute

registered_by: NotRequired[RegisteredBy]

Information about who registered the connector.

supported_api_versions instance-attribute

supported_api_versions: NotRequired[SupportedApiVersionList]

A list of API versions that are supported by the connector.

supported_data_transfer_apis instance-attribute

supported_data_transfer_apis: NotRequired[SupportedDataTransferApis]

The APIs of the connector application that Amazon AppFlow can use to transfer your data.

supported_data_transfer_types instance-attribute

supported_data_transfer_types: NotRequired[SupportedDataTransferTypeList]

The data transfer types that the connector supports.

RECORD

Structured records.

FILE

Files or binary data.

supported_destination_connectors instance-attribute

supported_destination_connectors: NotRequired[ConnectorTypeList]

Lists the connectors that are available for use as destinations.

supported_operators instance-attribute

supported_operators: NotRequired[SupportedOperatorList]

A list of operators supported by the connector.

supported_scheduling_frequencies instance-attribute

supported_scheduling_frequencies: NotRequired[SchedulingFrequencyTypeList]

Specifies the supported flow frequency for that connector.

supported_trigger_types instance-attribute

supported_trigger_types: NotRequired[TriggerTypeList]

Specifies the supported trigger types for the flow.

supported_write_operations instance-attribute

supported_write_operations: NotRequired[SupportedWriteOperationList]

A list of write operations supported by the connector.