DescribedConnector ¶

class DescribedConnector(TypedDict, closed=True):
    arn: "capo_transfer.types.arn.Arn"
    """<p>The unique Amazon Resource Name (ARN) for the connector.</p>"""
    connector_id: NotRequired["capo_transfer.types.connector_id.ConnectorId"]
    """<p>The unique identifier for the connector.</p>"""
    url: NotRequired["capo_transfer.types.url.Url"]
    """<p>The URL of the partner's AS2 or SFTP endpoint.</p> <p>When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null.</p>"""
    as2_config: NotRequired[
        "capo_transfer.types.as2_connector_config.As2ConnectorConfig"
    ]
    """<p>A structure that contains the parameters for an AS2 connector object.</p>"""
    access_role: NotRequired["capo_transfer.types.role.Role"]
    """<p>Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.</p> <p> <b>For AS2 connectors</b> </p> <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and specifying the file paths in the request parameter, <code>SendFilePaths</code>. We use the file’s parent directory (for example, for <code>--send-file-paths /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the <code>AccessRole</code> needs to provide read and write access to the parent directory of the file location used in the <code>StartFileTransfer</code> request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with <code>StartFileTransfer</code>.</p> <p>If you are using Basic authentication for your AS2 connector, the access role requires the <code>secretsmanager:GetSecretValue</code> permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the <code>kms:Decrypt</code> permission for that key.</p> <p> <b>For SFTP connectors</b> </p> <p>Make sure that the access role provides read and write access to the parent directory of the file location that's used in the <code>StartFileTransfer</code> request. Additionally, make sure that the role provides <code>secretsmanager:GetSecretValue</code> permission to Secrets Manager.</p>"""
    logging_role: NotRequired["capo_transfer.types.role.Role"]
    """<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.</p>"""
    tags: NotRequired["capo_transfer.types.tags.Tags"]
    """<p>Key-value pairs that can be used to group and search for connectors.</p>"""
    sftp_config: NotRequired[
        "capo_transfer.types.sftp_connector_config.SftpConnectorConfig"
    ]
    """<p>A structure that contains the parameters for an SFTP connector object.</p>"""
    service_managed_egress_ip_addresses: NotRequired[
        "capo_transfer.types.service_managed_egress_ip_addresses.ServiceManagedEgressIpAddresses"
    ]
    """<p>The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.</p>"""
    security_policy_name: NotRequired[
        "capo_transfer.types.connector_security_policy_name.ConnectorSecurityPolicyName"
    ]
    """<p>The text name of the security policy for the specified connector.</p>"""
    egress_config: NotRequired[
        "capo_transfer.types.described_connector_egress_config.DescribedConnectorEgressConfig"
    ]
    """<p>Current egress configuration of the connector, showing how traffic is routed to the SFTP server. Contains VPC Lattice settings when using VPC_LATTICE egress type.</p> <p>When using the VPC_LATTICE egress type, Transfer Family uses a managed Service Network to simplify the resource sharing process.</p>"""
    egress_type: "capo_transfer.types.connector_egress_type.ConnectorEgressType"
    """<p>Type of egress configuration for the connector. SERVICE_MANAGED uses Transfer Family managed NAT gateways, while VPC_LATTICE routes traffic through customer VPCs using VPC Lattice.</p>"""
    error_message: NotRequired[
        "capo_transfer.types.connector_error_message.ConnectorErrorMessage"
    ]
    """<p>Error message providing details when the connector is in ERRORED status. Contains information to help troubleshoot connector creation or operation failures.</p>"""
    status: "capo_transfer.types.connector_status.ConnectorStatus"
    """<p>Current status of the connector. PENDING indicates creation/update in progress, ACTIVE means ready for operations, and ERRORED indicates a failure requiring attention.</p>"""
    ip_address_type: NotRequired[
        "capo_transfer.types.connectors_ip_address_type.ConnectorsIpAddressType"
    ]
    """<p>IP address type for the connector's network connections. When set to <code>IPV4</code>, the connector uses IPv4 addresses only. When set to <code>DUALSTACK</code>, the connector supports both IPv4 and IPv6 addresses, with IPv6 preferred when available.</p>"""