SftpConnectorConfig (AWS Java SDK for AWS Transfer for SFTP 1.12.544 API)

java.lang.Object
- com.amazonaws.services.transfer.model.SftpConnectorConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SftpConnectorConfig
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a partner's SFTP server.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SftpConnectorConfig()

Constructors
Constructor and Description
`SftpConnectorConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SftpConnectorConfig`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getTrustedHostKeys()` The public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting.
`String`	`getUserSecretId()` The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setTrustedHostKeys(Collection<String> trustedHostKeys)` The public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting.
`void`	`setUserSecretId(String userSecretId)` The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both.
`String`	`toString()` Returns a string representation of this object.
`SftpConnectorConfig`	`withTrustedHostKeys(Collection<String> trustedHostKeys)` The public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting.
`SftpConnectorConfig`	`withTrustedHostKeys(String... trustedHostKeys)` The public portion of the host key, or keys, that are used to authenticate the user to the external server to which you are connecting.
`SftpConnectorConfig`	`withUserSecretId(String userSecretId)` The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SftpConnectorConfig
```
public SftpConnectorConfig()
```
- Method Detail
  - setUserSecretId
```
public void setUserSecretId(String userSecretId)
```
    The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.
    
    Parameters:
    
    userSecretId - The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.
  - getUserSecretId
```
public String getUserSecretId()
```
    The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.
    
    Returns:
    
    The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.
  - withUserSecretId
```
public SftpConnectorConfig withUserSecretId(String userSecretId)
```
    The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.
    
    Parameters:
    
    userSecretId - The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTrustedHostKeys
```
public List<String> getTrustedHostKeys()
```
    The public portion of the host key, or keys, that are used to authenticate the user to 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.
    
    For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
    - For RSA keys, the key type is ssh-rsa.
    - For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.
    Returns:
    The public portion of the host key, or keys, that are used to authenticate the user to 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.
    
    For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
    
    For RSA keys, the key type is ssh-rsa.
    
    For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384 , or ecdsa-sha2-nistp521, depending on the size of the key you generated.
  - setTrustedHostKeys
```
public void setTrustedHostKeys(Collection<String> trustedHostKeys)
```
    The public portion of the host key, or keys, that are used to authenticate the user to 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.
    
    For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
    - For RSA keys, the key type is ssh-rsa.
    - For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.
    Parameters:
    trustedHostKeys - The public portion of the host key, or keys, that are used to authenticate the user to 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.
    
    For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
    
    For RSA keys, the key type is ssh-rsa.
    
    For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.
  - withTrustedHostKeys
```
public SftpConnectorConfig withTrustedHostKeys(String... trustedHostKeys)
```
    The public portion of the host key, or keys, that are used to authenticate the user to 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.
    
    For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
    - For RSA keys, the key type is ssh-rsa.
    - For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.
    NOTE: This method appends the values to the existing list (if any). Use setTrustedHostKeys(java.util.Collection) or withTrustedHostKeys(java.util.Collection) if you want to override the existing values.
    Parameters:
    trustedHostKeys - The public portion of the host key, or keys, that are used to authenticate the user to 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.
    
    For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
    
    For RSA keys, the key type is ssh-rsa.
    
    For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTrustedHostKeys
```
public SftpConnectorConfig withTrustedHostKeys(Collection<String> trustedHostKeys)
```
    The public portion of the host key, or keys, that are used to authenticate the user to 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.
    
    For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
    - For RSA keys, the key type is ssh-rsa.
    - For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.
    Parameters:
    trustedHostKeys - The public portion of the host key, or keys, that are used to authenticate the user to 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.
    
    For the trusted host key, Transfer Family accepts RSA and ECDSA keys.
    
    For RSA keys, the key type is ssh-rsa.
    
    For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SftpConnectorConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class SftpConnectorConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SftpConnectorConfig

Method Detail

setUserSecretId

getUserSecretId

withUserSecretId

getTrustedHostKeys

setTrustedHostKeys

withTrustedHostKeys

withTrustedHostKeys

toString

equals

hashCode

clone

marshall