interface SftpConfigProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Transfer.CfnConnector.SftpConfigProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awstransfer#CfnConnector_SftpConfigProperty`
Java	`software.amazon.awscdk.services.transfer.CfnConnector.SftpConfigProperty`
Python	`aws_cdk.aws_transfer.CfnConnector.SftpConfigProperty`
TypeScript	`aws-cdk-lib` » `aws_transfer` » `CfnConnector` » `SftpConfigProperty`

A structure that contains the parameters for an SFTP connector object.

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 sftpConfigProperty: transfer.CfnConnector.SftpConfigProperty = {
  maxConcurrentConnections: 123,
  trustedHostKeys: ['trustedHostKeys'],
  userSecretId: 'userSecretId',
};

Properties

Name	Type	Description
maxConcurrentConnections?	`number`	Specify the number of concurrent connections that your connector creates to the remote server.
trustedHostKeys?	`string[]`	The public portion of the host key, or keys, that are used to identify the external server to which you are connecting.
userSecretId?	`string`	The identifier for the secret (in AWS Secrets Manager) that contains the SFTP user's private key, password, or both.

maxConcurrentConnections?

Type: number (optional, default: 1)

Specify the number of concurrent connections that your connector creates to the remote server.

The default value is 1 . The maximum values is 5 .

If you are using the AWS Management Console , the default value is 5 .

This parameter specifies the number of active connections that your connector can establish with the remote server at the same time. Increasing this value can enhance connector performance when transferring large file batches by enabling parallel operations.

trustedHostKeys?

Type: string[] (optional)

The public portion of the host key, or keys, that are used to identify the external server to which you are connecting.

You can use the ssh-keyscan command against the SFTP server to retrieve the necessary key.

TrustedHostKeys is optional for CreateConnector . If not provided, you can use TestConnection to retrieve the server host key during the initial connection attempt, and subsequently update the connector with the observed host key.

The three standard SSH public key format elements are <key type> , <body base64> , and an optional <comment> , with spaces between each element. Specify only the <key type> and <body base64> : do not enter the <comment> portion of the key.

For the trusted host key, AWS Transfer Family accepts RSA and ECDSA keys.

For RSA keys, the <key type> string is ssh-rsa .
For ECDSA keys, the <key type> string is either ecdsa-sha2-nistp256 , ecdsa-sha2-nistp384 , or ecdsa-sha2-nistp521 , depending on the size of the key you generated.

Run this command to retrieve the SFTP server host key, where your SFTP server name is ftp.host.com .

ssh-keyscan ftp.host.com

This prints the public host key to standard output.

ftp.host.com ssh-rsa AAAAB3Nza...<long-string-for-public-key

Copy and paste this string into the TrustedHostKeys field for the create-connector command or into the Trusted host keys field in the console.

userSecretId?

Type: string (optional)

The identifier for the secret (in AWS Secrets Manager) that contains the SFTP user's private key, password, or both.

The identifier must be the Amazon Resource Name (ARN) of the secret.

Required when creating an SFTP connector

Optional when updating an existing SFTP connector