Class: Aws::Transfer::Types::CreateAgreementRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transfer/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)


349
350
351
352
353
354
355
356
357
358
359
360
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 349

class CreateAgreementRequest < Struct.new(
  :description,
  :server_id,
  :local_profile_id,
  :partner_profile_id,
  :base_directory,
  :access_role,
  :status,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#base_directoryString

The landing directory (folder) for files transferred by using the AS2 protocol.

A BaseDirectory example is DOC-EXAMPLE-BUCKET/home/mydirectory.

Returns:

  • (String)


349
350
351
352
353
354
355
356
357
358
359
360
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 349

class CreateAgreementRequest < Struct.new(
  :description,
  :server_id,
  :local_profile_id,
  :partner_profile_id,
  :base_directory,
  :access_role,
  :status,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A name or short description to identify the agreement.

Returns:

  • (String)


349
350
351
352
353
354
355
356
357
358
359
360
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 349

class CreateAgreementRequest < Struct.new(
  :description,
  :server_id,
  :local_profile_id,
  :partner_profile_id,
  :base_directory,
  :access_role,
  :status,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#local_profile_idString

A unique identifier for the AS2 local profile.

Returns:

  • (String)


349
350
351
352
353
354
355
356
357
358
359
360
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 349

class CreateAgreementRequest < Struct.new(
  :description,
  :server_id,
  :local_profile_id,
  :partner_profile_id,
  :base_directory,
  :access_role,
  :status,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#partner_profile_idString

A unique identifier for the partner profile used in the agreement.

Returns:

  • (String)


349
350
351
352
353
354
355
356
357
358
359
360
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 349

class CreateAgreementRequest < Struct.new(
  :description,
  :server_id,
  :local_profile_id,
  :partner_profile_id,
  :base_directory,
  :access_role,
  :status,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#server_idString

A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.

Returns:

  • (String)


349
350
351
352
353
354
355
356
357
358
359
360
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 349

class CreateAgreementRequest < Struct.new(
  :description,
  :server_id,
  :local_profile_id,
  :partner_profile_id,
  :base_directory,
  :access_role,
  :status,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the agreement. The agreement can be either ACTIVE or INACTIVE.

Returns:

  • (String)


349
350
351
352
353
354
355
356
357
358
359
360
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 349

class CreateAgreementRequest < Struct.new(
  :description,
  :server_id,
  :local_profile_id,
  :partner_profile_id,
  :base_directory,
  :access_role,
  :status,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



349
350
351
352
353
354
355
356
357
358
359
360
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 349

class CreateAgreementRequest < Struct.new(
  :description,
  :server_id,
  :local_profile_id,
  :partner_profile_id,
  :base_directory,
  :access_role,
  :status,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end