Class: Aws::Transfer::Types::CreateConnectorRequest

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

Overview

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)

431
432
433
434
435
436
437
438
439
# File 'lib/aws-sdk-transfer/types.rb', line 431

class CreateConnectorRequest < Struct.new(
  :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.


431
432
433
434
435
436
437
438
439
# File 'lib/aws-sdk-transfer/types.rb', line 431

class CreateConnectorRequest < Struct.new(
  :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)

431
432
433
434
435
436
437
438
439
# File 'lib/aws-sdk-transfer/types.rb', line 431

class CreateConnectorRequest < Struct.new(
  :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. Tags are metadata attached to connectors for any purpose.

Returns:


431
432
433
434
435
436
437
438
439
# File 'lib/aws-sdk-transfer/types.rb', line 431

class CreateConnectorRequest < Struct.new(
  :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)

431
432
433
434
435
436
437
438
439
# File 'lib/aws-sdk-transfer/types.rb', line 431

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