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

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

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_role ⇒ String

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) 

1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
 
# File 'lib/aws-sdk-transfer/types.rb', line 1975

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

#arn ⇒ String

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

Returns:

  • (String) 

1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
 
# File 'lib/aws-sdk-transfer/types.rb', line 1975

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

#as_2_config ⇒ Types::As2ConnectorConfig

A structure that contains the parameters for a connector object.

Returns:


1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
 
# File 'lib/aws-sdk-transfer/types.rb', line 1975

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

#connector_id ⇒ String

The unique identifier for the connector.

Returns:

  • (String) 

1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
 
# File 'lib/aws-sdk-transfer/types.rb', line 1975

class DescribedConnector < Struct.new(
  :arn,
  :connector_id,
  :url,
  :as_2_config,
  :access_role,
  :logging_role,
  :tags)
  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) 

1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
 
# File 'lib/aws-sdk-transfer/types.rb', line 1975

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

#tags ⇒ Array<Types::Tag>

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

Returns:


1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
 
# File 'lib/aws-sdk-transfer/types.rb', line 1975

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

#url ⇒ String

The URL of the partner's AS2 endpoint.

Returns:

  • (String) 

1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
 
# File 'lib/aws-sdk-transfer/types.rb', line 1975

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