1.204.0

interface CfnAgreementProps

LanguageType name
.NETAmazon.CDK.AWS.Transfer.CfnAgreementProps
Javasoftware.amazon.awscdk.services.transfer.CfnAgreementProps
Pythonaws_cdk.aws_transfer.CfnAgreementProps
TypeScript @aws-cdk/aws-transfer » CfnAgreementProps

Properties for defining a CfnAgreement.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as transfer from '@aws-cdk/aws-transfer';
const cfnAgreementProps: transfer.CfnAgreementProps = {
  accessRole: 'accessRole',
  baseDirectory: 'baseDirectory',
  localProfileId: 'localProfileId',
  partnerProfileId: 'partnerProfileId',
  serverId: 'serverId',

  // the properties below are optional
  description: 'description',
  status: 'status',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
accessRolestringWith AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths .
baseDirectorystringThe landing directory (folder) for files that are transferred by using the AS2 protocol.
localProfileIdstringA unique identifier for the AS2 local profile.
partnerProfileIdstringA unique identifier for the partner profile used in the agreement.
serverIdstringA system-assigned unique identifier for a server instance.
description?stringThe name or short description that's used to identify the agreement.
status?stringThe current status of the agreement, either ACTIVE or INACTIVE .
tags?CfnTag[]Key-value pairs that can be used to group and search for agreements.

accessRole

Type: 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 .

baseDirectory

Type: string

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

localProfileId

Type: string

A unique identifier for the AS2 local profile.

partnerProfileId

Type: string

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

serverId

Type: string

A system-assigned unique identifier for a server instance.

This identifier indicates the specific server that the agreement uses.

description?

Type: string (optional)

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

status?

Type: string (optional)

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

tags?

Type: CfnTag[] (optional)

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

← PreviousNext →