# CreateConnector Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see [Configure AS2 connectors](https://docs.aws.amazon.com/transfer/latest/userguide/configure-as2-connector.html) and [Create SFTP connectors](https://docs.aws.amazon.com/transfer/latest/userguide/configure-sftp-connector.html). **Note** You must specify exactly one configuration object: either for AS2 (`As2Config`) or SFTP (`SftpConfig`). ## Request Syntax ``` { "AccessRole": "string", "As2Config": { "AsyncMdnConfig": { "ServerIds": [ "string" ], "Url": "string" }, "BasicAuthSecretId": "string", "Compression": "string", "EncryptionAlgorithm": "string", "LocalProfileId": "string", "MdnResponse": "string", "MdnSigningAlgorithm": "string", "MessageSubject": "string", "PartnerProfileId": "string", "PreserveContentType": "string", "SigningAlgorithm": "string" }, "EgressConfig": { ... }, "LoggingRole": "string", "SecurityPolicyName": "string", "SftpConfig": { "MaxConcurrentConnections": number, "TrustedHostKeys": [ "string" ], "UserSecretId": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "Url": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AccessRole](#API_CreateConnector_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:.*role/\S+` Required: Yes ** [As2Config](#API_CreateConnector_RequestSyntax) ** A structure that contains the parameters for an AS2 connector object. Type: [As2ConnectorConfig](API_As2ConnectorConfig.md) object Required: No ** [EgressConfig](#API_CreateConnector_RequestSyntax) ** Specifies the egress configuration for the connector, which determines how traffic is routed from the connector to the SFTP server. When set to VPC, enables routing through customer VPCs using VPC\$1LATTICE for private connectivity. Type: [ConnectorEgressConfig](API_ConnectorEgressConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: No ** [LoggingRole](#API_CreateConnector_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `arn:.*role/\S+` Required: No ** [SecurityPolicyName](#API_CreateConnector_RequestSyntax) ** Specifies the name of the security policy for the connector. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: `TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+` Required: No ** [SftpConfig](#API_CreateConnector_RequestSyntax) ** A structure that contains the parameters for an SFTP connector object. Type: [SftpConnectorConfig](API_SftpConnectorConfig.md) object Required: No ** [Tags](#API_CreateConnector_RequestSyntax) ** Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 50 items. Required: No ** [Url](#API_CreateConnector_RequestSyntax) ** The URL of the partner's AS2 or SFTP endpoint. When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ## Response Syntax ``` { "ConnectorId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ConnectorId](#API_CreateConnector_ResponseSyntax) ** The unique identifier for the connector, returned after the API call succeeds. Type: String Length Constraints: Fixed length of 19. Pattern: `c-([0-9a-f]{17})` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServiceError ** This exception is thrown when an error occurs in the AWS Transfer Family service. HTTP Status Code: 500 ** InvalidRequestException ** This exception is thrown when the client submits a malformed request. HTTP Status Code: 400 ** ResourceExistsException ** The requested resource does not exist, or exists in a region other than the one specified for the command. HTTP Status Code: 400 ** ResourceNotFoundException ** This exception is thrown when a resource is not found by the AWSTransfer Family service. HTTP Status Code: 400 ** ServiceUnavailableException ** The request has failed because the AWSTransfer Family service is not available. HTTP Status Code: 500 ** ThrottlingException ** The request was denied due to request throttling. HTTP Status Code: 400 ## Examples ### Example The following example creates an AS2 connector. In the command, replace items as follows: + `url`: provide the URL for the trading partner's AS2 server. + `your-IAM-role-for-bucket-access`: an IAM role that has access to the Amazon S3 bucket you are using to store your files. + Use the ARN for your logging role, which includes your AWS account ID. + Provide a path to a file that contains the AS2 connector configuration parameters. The AS2 connector configuration object is described in [As2ConnectorConfig](https://docs.aws.amazon.com/transfer/latest/userguide/API_As2ConnectorConfig). ``` // Listing for testAs2Config.json { "LocalProfileId": "your-profile-id", "PartnerProfileId": "partner-profile-id", "MdnResponse": "SYNC", "Compression": "ZLIB", "EncryptionAlgorithm": "AES256_CBC", "SigningAlgorithm": "SHA256", "MdnSigningAlgorithm": "DEFAULT", "MessageSubject": "Your Message Subject" } ``` ``` aws transfer create-connector --url "http://partner-as2-server-url" \ --access-role your-IAM-role-for-bucket-access \ --logging-role arn:aws:iam::your-account-id:role/service-role/AWSTransferLoggingAccess \ --as2-config file://path/to/testAS2Config.json ``` ### Example The following example creates an SFTP connector. In the command, replace items as follows: + `sftp-server-url`: provide the URL for the SFTP server with which you are exchanging files. + `your-IAM-role-for-bucket-access`: an IAM role that has access to the Amazon S3 bucket you are using to store your files. + Use the ARN for your logging role, which includes your AWS account ID. + Provide a path to a file that contains the SFTP connector configuration parameters. The SFTP connector configuration object is described in [SftpConnectorConfig](https://docs.aws.amazon.com/transfer/latest/userguide/API_SftpConnectorConfig). ``` // Listing for testSFTPConfig.json { "UserSecretId": "arn:aws:secretsmanager:us-east-2:123456789012:secret:aws/transfer/example-username-key", "TrustedHostKeys": [ "sftp.example.com ssh-rsa AAAAbbbb...EEEE=" ] } ``` ``` aws transfer create-connector --url "sftp://sftp-server-url" \ --access-role your-IAM-role-for-bucket-access \ --logging-role arn:aws:iam::your-account-id:role/service-role/AWSTransferLoggingAccess \ --sftp-config file://path/to/testSFTPConfig.json ``` ### Example The API call returns the connector ID for the new connector. #### Sample Response ``` { "ConnectorId": "c-11112222333344444" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/transfer-2018-11-05/CreateConnector) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/transfer-2018-11-05/CreateConnector) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/CreateConnector) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/transfer-2018-11-05/CreateConnector) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/CreateConnector) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/transfer-2018-11-05/CreateConnector) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/transfer-2018-11-05/CreateConnector) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/transfer-2018-11-05/CreateConnector) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/transfer-2018-11-05/CreateConnector) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/CreateConnector)