Class: Aws::Transfer::Types::DescribedConnector

Inherits:

Struct

• Object
• Struct
• Aws::Transfer::Types::DescribedConnector

Defined in:

gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #access_role ⇒ String

  Connectors are used to send files using either the AS2 or SFTP protocol.

• #arn ⇒ String

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

• #as_2_config ⇒ Types::As2ConnectorConfig

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

• #connector_id ⇒ String

  The unique identifier for the connector.

• #egress_config ⇒ Types::DescribedConnectorEgressConfig

  Current egress configuration of the connector, showing how traffic is routed to the SFTP server.

• #egress_type ⇒ String

  Type of egress configuration for the connector.

• #error_message ⇒ String

  Error message providing details when the connector is in ERRORED status.

• #logging_role ⇒ String

  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.

• #security_policy_name ⇒ String

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

• #service_managed_egress_ip_addresses ⇒ Array<String>

  The list of egress IP addresses of this connector.

• #sftp_config ⇒ Types::SftpConnectorConfig

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

• #status ⇒ String

  Current status of the connector.

• #tags ⇒ Array<Types::Tag>

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

• #url ⇒ String

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

Instance Attribute Details

#access_role ⇒ String

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.

For AS2 connectors

With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) 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 AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue 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 kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2707

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags,
  :sftp_config,
  :service_managed_egress_ip_addresses,
  :security_policy_name,
  :egress_config,
  :egress_type,
  :error_message,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2707

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags,
  :sftp_config,
  :service_managed_egress_ip_addresses,
  :security_policy_name,
  :egress_config,
  :egress_type,
  :error_message,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#as_2_config ⇒ Types::As2ConnectorConfig

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

Returns:

• (Types::As2ConnectorConfig)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2707

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags,
  :sftp_config,
  :service_managed_egress_ip_addresses,
  :security_policy_name,
  :egress_config,
  :egress_type,
  :error_message,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#connector_id ⇒ String

The unique identifier for the connector.

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2707

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags,
  :sftp_config,
  :service_managed_egress_ip_addresses,
  :security_policy_name,
  :egress_config,
  :egress_type,
  :error_message,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#egress_config ⇒ Types::DescribedConnectorEgressConfig

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.

When using the VPC_LATTICE egress type, Transfer Family uses a managed Service Network to simplify the resource sharing process.

Returns:

• (Types::DescribedConnectorEgressConfig)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2707

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags,
  :sftp_config,
  :service_managed_egress_ip_addresses,
  :security_policy_name,
  :egress_config,
  :egress_type,
  :error_message,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#egress_type ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2707

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags,
  :sftp_config,
  :service_managed_egress_ip_addresses,
  :security_policy_name,
  :egress_config,
  :egress_type,
  :error_message,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#error_message ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2707

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags,
  :sftp_config,
  :service_managed_egress_ip_addresses,
  :security_policy_name,
  :egress_config,
  :egress_type,
  :error_message,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#logging_role ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2707

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags,
  :sftp_config,
  :service_managed_egress_ip_addresses,
  :security_policy_name,
  :egress_config,
  :egress_type,
  :error_message,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#security_policy_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2707

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags,
  :sftp_config,
  :service_managed_egress_ip_addresses,
  :security_policy_name,
  :egress_config,
  :egress_type,
  :error_message,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#service_managed_egress_ip_addresses ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2707

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags,
  :sftp_config,
  :service_managed_egress_ip_addresses,
  :security_policy_name,
  :egress_config,
  :egress_type,
  :error_message,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#sftp_config ⇒ Types::SftpConnectorConfig

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

Returns:

• (Types::SftpConnectorConfig)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2707

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags,
  :sftp_config,
  :service_managed_egress_ip_addresses,
  :security_policy_name,
  :egress_config,
  :egress_type,
  :error_message,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2707

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags,
  :sftp_config,
  :service_managed_egress_ip_addresses,
  :security_policy_name,
  :egress_config,
  :egress_type,
  :error_message,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2707

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags,
  :sftp_config,
  :service_managed_egress_ip_addresses,
  :security_policy_name,
  :egress_config,
  :egress_type,
  :error_message,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#url ⇒ String

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

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.

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2707

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags,
  :sftp_config,
  :service_managed_egress_ip_addresses,
  :security_policy_name,
  :egress_config,
  :egress_type,
  :error_message,
  :status)
  SENSITIVE = []
  include Aws::Structure
end