transfer/aws.sdk.kotlin.services.transfer.model/UpdateAgreementRequest

UpdateAgreementRequest

class UpdateAgreementRequest

Types

Builder

class Builder

Companion

object Companion

Properties

accessRole

val accessRole: String?

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

val agreementId: String?

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

baseDirectory

val baseDirectory: String?

To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want to use; for example, /DOC-EXAMPLE-BUCKET/home/mydirectory .

description

val description: String?

To replace the existing description, provide a short description for the agreement.

localProfileId

val localProfileId: String?

A unique identifier for the AS2 local profile.

partnerProfileId

val partnerProfileId: String?

A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.

serverId

val serverId: String?

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

status

val status: AgreementStatusType?

You can update the status for the agreement, either activating an inactive agreement or the reverse.

Functions

copy

inline fun copy(block: UpdateAgreementRequest.Builder.() -> Unit = {}): UpdateAgreementRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String