java.lang.Object
- software.amazon.awssdk.services.transfer.model.SftpConnectorConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SftpConnectorConfig.Builder,SftpConnectorConfig>
```
@Generated("software.amazon.awssdk:codegen")
public final class SftpConnectorConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SftpConnectorConfig.Builder,SftpConnectorConfig>
```
Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a partner's SFTP server.

Because the 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SftpConnectorConfig.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SftpConnectorConfig.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTrustedHostKeys()`	For responses, this returns true if the service returned a value for the TrustedHostKeys property.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SftpConnectorConfig.Builder>`	`serializableBuilderClass()`
`SftpConnectorConfig.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<String>`	`trustedHostKeys()`	The public portion of the host key, or keys, that are used to identify the external server to which you are connecting.
`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - userSecretId
```
public final 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 must be the Amazon Resource Name (ARN) 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 must be the Amazon Resource Name (ARN) of the secret.
  - hasTrustedHostKeys
```
public final boolean hasTrustedHostKeys()
```
    For responses, this returns true if the service returned a value for the TrustedHostKeys property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - trustedHostKeys
```
public final List<String> trustedHostKeys()
```
    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.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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTrustedHostKeys() method.
    Returns:
    
    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.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.
  - toBuilder
```
public SftpConnectorConfig.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SftpConnectorConfig.Builder,SftpConnectorConfig>
  - builder
```
public static SftpConnectorConfig.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SftpConnectorConfig.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class SftpConnectorConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

userSecretId

hasTrustedHostKeys

trustedHostKeys

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField