transfer/aws.sdk.kotlin.services.transfer.model/DescribedAgreement/Builder

Builder

Properties

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.

agreementId

var agreementId: String?

A unique identifier for the agreement. This identifier is returned when you create an agreement.

arn

var arn: String?

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

baseDirectory

var baseDirectory: String?

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

description

var description: String?

The name or short description that's used to identify the agreement.

localProfileId

var localProfileId: String?

A unique identifier for the AS2 local profile.

partnerProfileId

var partnerProfileId: String?

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

serverId

var serverId: String?

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

status

var status: AgreementStatusType?

The current status of the agreement, either ACTIVE or INACTIVE.