Class: Aws::Transfer::Types::SftpConnectorConfig
- Inherits:
-
Struct
- Object
- Struct
- Aws::Transfer::Types::SftpConnectorConfig
- Defined in:
- gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb
Overview
Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a partner's SFTP server.
SftpConnectorConfig
data type is used for both creating
and updating SFTP connectors, its parameters, TrustedHostKeys
and
UserSecretId
are marked as not required. This is a bit misleading,
as they are not required when you are updating an existing SFTP
connector, but are required when you are creating a new SFTP
connector.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#trusted_host_keys ⇒ Array<String>
The public portion of the host key, or keys, that are used to identify the external server to which you are connecting.
-
#user_secret_id ⇒ String
The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both.
Instance Attribute Details
#trusted_host_keys ⇒ Array<String>
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 isssh-rsa
.For ECDSA keys, the
<key type>
string is eitherecdsa-sha2-nistp256
,ecdsa-sha2-nistp384
, orecdsa-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.
5542 5543 5544 5545 5546 5547 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5542 class SftpConnectorConfig < Struct.new( :user_secret_id, :trusted_host_keys) SENSITIVE = [] include Aws::Structure end |
#user_secret_id ⇒ 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.
5542 5543 5544 5545 5546 5547 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5542 class SftpConnectorConfig < Struct.new( :user_secret_id, :trusted_host_keys) SENSITIVE = [] include Aws::Structure end |