Class CfnConnectorPropsMixin.SftpConfigProperty

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

Inheritance
object
CfnConnectorPropsMixin.SftpConfigProperty
Inherited Members
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Transfer
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnConnectorPropsMixin.SftpConfigProperty : CfnConnectorPropsMixin.ISftpConfigProperty
Syntax (vb)
Public Class CfnConnectorPropsMixin.SftpConfigProperty Implements CfnConnectorPropsMixin.ISftpConfigProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-sftpconfig.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Transfer;

             var sftpConfigProperty = new SftpConfigProperty {
                 MaxConcurrentConnections = 123,
                 TrustedHostKeys = new [] { "trustedHostKeys" },
                 UserSecretId = "userSecretId"
             };

Synopsis

Constructors

SftpConfigProperty()

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

Properties

MaxConcurrentConnections

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

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

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

Constructors

SftpConfigProperty()

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

public SftpConfigProperty()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-sftpconfig.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Transfer;

             var sftpConfigProperty = new SftpConfigProperty {
                 MaxConcurrentConnections = 123,
                 TrustedHostKeys = new [] { "trustedHostKeys" },
                 UserSecretId = "userSecretId"
             };

Properties

MaxConcurrentConnections

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

public double? MaxConcurrentConnections { get; set; }
Property Value

double?

Remarks

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

If you are using the AWS Management Console , the default value is <code>5</code> .

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.

Default: - 1

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-sftpconfig.html#cfn-transfer-connector-sftpconfig-maxconcurrentconnections

TrustedHostKeys

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

public string[]? TrustedHostKeys { get; set; }
Property Value

string[]

Remarks

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

<code>TrustedHostKeys</code> is optional for <code>CreateConnector</code> . If not provided, you can use <code>TestConnection</code> 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...<long-string-for-public-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.

    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.

    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...<long-string-for-public-key>

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-sftpconfig.html#cfn-transfer-connector-sftpconfig-trustedhostkeys

    UserSecretId

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

    public string? UserSecretId { get; set; }
    Property Value

    string

    Remarks

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

    <ul></ul>

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-sftpconfig.html#cfn-transfer-connector-sftpconfig-usersecretid

    Implements