All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnConnector.SftpConfigProperty.Jsii$Proxy

Enclosing class:: CfnConnector

@Stability(Stable) public static interface CfnConnector.SftpConfigProperty extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.transfer.*;
 SftpConfigProperty sftpConfigProperty = SftpConfigProperty.builder()
         .trustedHostKeys(List.of("trustedHostKeys"))
         .userSecretId("userSecretId")
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnConnector.SftpConfigProperty.Builder

A builder for CfnConnector.SftpConfigProperty

static final class

CfnConnector.SftpConfigProperty.Jsii$Proxy

An implementation for CfnConnector.SftpConfigProperty
Method Summary

Modifier and Type

Method

Description

static CfnConnector.SftpConfigProperty.Builder

builder()

default List<String>

getTrustedHostKeys()

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

default String

getUserSecretId()

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getTrustedHostKeys
  
  @Stability(Stable) @Nullable default List<String> getTrustedHostKeys()
  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, AWS 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-sftpconfig.html#cfn-transfer-connector-sftpconfig-trustedhostkeys
- getUserSecretId
  
  @Stability(Stable) @Nullable default String getUserSecretId()
  
  The identifier for the secret (in AWS 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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-sftpconfig.html#cfn-transfer-connector-sftpconfig-usersecretid
- builder
  
  @Stability(Stable) static CfnConnector.SftpConfigProperty.Builder builder()
  
  Returns:
  
  a CfnConnector.SftpConfigProperty.Builder of CfnConnector.SftpConfigProperty

Interface CfnConnector.SftpConfigProperty

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getTrustedHostKeys

getUserSecretId

builder