This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # AWS::Transfer::Connector SftpConfig A structure that contains the parameters for an SFTP connector object. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MaxConcurrentConnections](#cfn-transfer-connector-sftpconfig-maxconcurrentconnections)" : {{Integer}}, "[TrustedHostKeys](#cfn-transfer-connector-sftpconfig-trustedhostkeys)" : {{[ String, ... ]}}, "[UserSecretId](#cfn-transfer-connector-sftpconfig-usersecretid)" : {{String}} } ``` ### YAML ``` [MaxConcurrentConnections](#cfn-transfer-connector-sftpconfig-maxconcurrentconnections): {{Integer}} [TrustedHostKeys](#cfn-transfer-connector-sftpconfig-trustedhostkeys): {{ - String}} [UserSecretId](#cfn-transfer-connector-sftpconfig-usersecretid): {{String}} ``` ## Properties `MaxConcurrentConnections` 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. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TrustedHostKeys` 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. When creating connectors with egress config (VPC\_LATTICE type connectors), since host name is not something we can verify, the only accepted trusted host key format is `key-type key-body` without the host name. For example: `ssh-rsa AAAAB3Nza...` The three standard SSH public key format elements are ``, ``, and an optional ``, with spaces between each element. Specify only the `` and ``: do not enter the `` portion of the key. For the trusted host key, AWS Transfer Family accepts RSA and ECDSA keys. + For RSA keys, the `` string is `ssh-rsa`. + For ECDSA keys, the `` 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...` Copy and paste this string into the `TrustedHostKeys` field for the `create-connector` command or into the **Trusted host keys** field in the console. For VPC Lattice type connectors (VPC\_LATTICE), remove the hostname from the key and use only the `key-type key-body` format. In this example, it should be: `ssh-rsa AAAAB3Nza...` *Required*: No *Type*: Array of String *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UserSecretId` 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 *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)