interface CfnAgreementProps

Language	Type name
.NET	`Amazon.CDK.AWS.Transfer.CfnAgreementProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awstransfer#CfnAgreementProps`
Java	`software.amazon.awscdk.services.transfer.CfnAgreementProps`
Python	`aws_cdk.aws_transfer.CfnAgreementProps`
TypeScript	`aws-cdk-lib` » `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 { aws_transfer as transfer } from 'aws-cdk-lib';
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

Name	Type	Description
accessRole	`string`	Connectors are used to send files using either the AS2 or SFTP protocol.
baseDirectory	`string`	The landing directory (folder) for files that are transferred by using the AS2 protocol.
localProfileId	`string`	A unique identifier for the AS2 local profile.
partnerProfileId	`string`	A unique identifier for the partner profile used in the agreement.
serverId	`string`	A system-assigned unique identifier for a server instance.
description?	`string`	The name or short description that's used to identify the agreement.
status?	`string`	The 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

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 AWS Identity and Access Management role to use.

For AS2 connectors

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 .

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to AWS Secrets Manager .

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.