DescribedConnector

Describes the parameters for the connector, as identified by the ConnectorId.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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.

Link copied to clipboard
val arn: String

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

Link copied to clipboard

A structure that contains the parameters for an AS2 connector object.

Link copied to clipboard

The unique identifier for the connector.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Error message providing details when the connector is in ERRORED status. Contains information to help troubleshoot connector creation or operation failures.

Link copied to clipboard

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.

Link copied to clipboard

The text name of the security policy for the specified connector.

Link copied to clipboard

The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.

Link copied to clipboard

A structure that contains the parameters for an SFTP connector object.

Link copied to clipboard

Current status of the connector. PENDING indicates creation/update in progress, ACTIVE means ready for operations, and ERRORED indicates a failure requiring attention.

Link copied to clipboard
val tags: List<Tag>?

Key-value pairs that can be used to group and search for connectors.

Link copied to clipboard
val url: String?

The URL of the partner's AS2 or SFTP endpoint.

Functions

Link copied to clipboard
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String