1.204.0

interface CfnConnectorProps

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

Properties for defining a CfnConnector.

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';

declare const as2Config: any;
const cfnConnectorProps: transfer.CfnConnectorProps = {
  accessRole: 'accessRole',
  as2Config: as2Config,
  url: 'url',

  // the properties below are optional
  loggingRole: 'loggingRole',
  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 .
as2ConfiganyA structure that contains the parameters for a connector object.
urlstringThe URL of the partner's AS2 endpoint.
loggingRole?stringThe Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events.
tags?CfnTag[]Key-value pairs that can be used to group and search for connectors.

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 .

as2Config

Type: any

A structure that contains the parameters for a connector object.

url

Type: string

The URL of the partner's AS2 endpoint.

loggingRole?

Type: string (optional)

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events.

When set, you can view connector activity in your CloudWatch logs.

tags?

Type: CfnTag[] (optional)

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

← PreviousNext →