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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_roleString

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.

Returns:

  • (String)


1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1925

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#arnString

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

Returns:

  • (String)


1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1925

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#as_2_configTypes::As2ConnectorConfig

A structure that contains the parameters for a connector object.



1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1925

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#connector_idString

The unique identifier for the connector.

Returns:

  • (String)


1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1925

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#logging_roleString

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)


1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1925

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1925

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#urlString

The URL of the partner's AS2 endpoint.

Returns:

  • (String)


1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1925

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end