Struct aws_sdk_transfer::types::SftpConnectorConfig
source · #[non_exhaustive]pub struct SftpConnectorConfig {
pub user_secret_id: Option<String>,
pub trusted_host_keys: Option<Vec<String>>,
}Expand description
Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a partner's SFTP server.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.user_secret_id: Option<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.
trusted_host_keys: Option<Vec<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.
Implementations§
source§impl SftpConnectorConfig
impl SftpConnectorConfig
sourcepub fn user_secret_id(&self) -> Option<&str>
pub fn user_secret_id(&self) -> Option<&str>
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.
sourcepub fn trusted_host_keys(&self) -> &[String]
pub fn trusted_host_keys(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .trusted_host_keys.is_none().
source§impl SftpConnectorConfig
impl SftpConnectorConfig
sourcepub fn builder() -> SftpConnectorConfigBuilder
pub fn builder() -> SftpConnectorConfigBuilder
Creates a new builder-style object to manufacture SftpConnectorConfig.
Trait Implementations§
source§impl Clone for SftpConnectorConfig
impl Clone for SftpConnectorConfig
source§fn clone(&self) -> SftpConnectorConfig
fn clone(&self) -> SftpConnectorConfig
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moresource§impl Debug for SftpConnectorConfig
impl Debug for SftpConnectorConfig
source§impl PartialEq for SftpConnectorConfig
impl PartialEq for SftpConnectorConfig
source§fn eq(&self, other: &SftpConnectorConfig) -> bool
fn eq(&self, other: &SftpConnectorConfig) -> bool
self and other values to be equal, and is used
by ==.