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 Identity and Access Management role to use.For AS2 connectorsWith 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 Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.For SFTP connectorsMake 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 Secrets Manager.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-As2Config_BasicAuthSecretId <
String>
Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication, you must provide the name or Amazon Resource Name (ARN) of a secret in Secrets Manager.The default value for this parameter is
null, which indicates that Basic authentication is not enabled for the connector.If the connector should use Basic authentication, the secret needs to be in the following format:
{ "Username": "user-name", "Password": "user-password" }Replace
user-name and
user-password with the credentials for the actual user that is being authenticated.Note the following:
- You are storing these credentials in Secrets Manager, not passing them directly into this API.
- If you are using the API, SDKs, or CloudFormation to configure your connector, then you must create the secret before you can enable Basic authentication. However, if you are using the Amazon Web Services management console, you can have the system create the secret for you.
If you have previously enabled Basic authentication for a connector, you can disable it by using the
UpdateConnector API call. For example, if you are using the CLI, you can run the following command to remove Basic authentication:
update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""' Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Specifies whether the AS2 file is compressed.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The algorithm that is used to encrypt the file.Note the following:
- Do not use the DES_EDE3_CBC algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.
- You can only specify NONE if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-As2Config_LocalProfileId <
String>
A unique identifier for the AS2 local profile.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:
- SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).
- NONE: Specifies that no MDN response is required.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The signing algorithm for the MDN response.If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-As2Config_MessageSubject <
String>
Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-As2Config_PartnerProfileId <
String>
A unique identifier for the partner profile for the connector.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The algorithm that is used to sign the AS2 messages sent with the connector.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Amazon.PowerShell.Cmdlets.TFR.AmazonTransferClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The unique identifier for the connector.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The Amazon Resource Name (ARN) of the 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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Changes the cmdlet behavior to return the value passed to the ConnectorId parameter. The -PassThru parameter is deprecated, use -Select '^ConnectorId' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Specifies the name of the security policy for the connector.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Use the -Select parameter to control the cmdlet output. The default value is 'ConnectorId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Transfer.Model.UpdateConnectorResponse). Specifying the name of a property of type Amazon.Transfer.Model.UpdateConnectorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.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, 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.comThis prints the public host key to standard output.
ftp.host.com ssh-rsa AAAAB3Nza...<long-string-for-public-keyCopy and paste this string into the
TrustedHostKeys field for the
create-connector command or into the
Trusted host keys field in the console.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SftpConfig_TrustedHostKeys |
-SftpConfig_UserSecretId <
String>
The identifier for the secret (in Amazon Web Services 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? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The URL of the partner's AS2 or SFTP endpoint.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |