CreateConnector

AS2 또는 SFTP 프로토콜의 아웃바운드 연결에 대한 파라미터를 캡처하는 커넥터를 생성합니다. AS2에 대해 커넥터는 외부에서 호스팅되는 AS2 서버로 파일을 전송하는 데 필요합니다. SFTP의 경우 SFTP 서버로 파일을 보내거나 SFTP 서버에서 파일을 받을 때 커넥터가 필요합니다. 커넥터에 대한 자세한 내용은 AS2 커넥터 구성 및 SFTP 커넥터 생성을 참조하십시오.

참고

AS2 (As2Config) 또는 SFTP (SftpConfig) 에 대해 정확히 하나의 구성 객체를 지정해야 합니다.

구문 요청


{
   "AccessRole": "string",
   "As2Config": { 
      "BasicAuthSecretId": "string",
      "Compression": "string",
      "EncryptionAlgorithm": "string",
      "LocalProfileId": "string",
      "MdnResponse": "string",
      "MdnSigningAlgorithm": "string",
      "MessageSubject": "string",
      "PartnerProfileId": "string",
      "SigningAlgorithm": "string"
   },
   "LoggingRole": "string",
   "SecurityPolicyName": "string",
   "SftpConfig": { 
      "TrustedHostKeys": [ "string" ],
      "UserSecretId": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Url": "string"
}

요청 파라미터

모든 작업에서 사용하는 파라미터에 대한 자세한 내용은 범용 파라미터를 참조하세요.

요청은 JSON 형식으로 다음 데이터를 받습니다.

AccessRole

커넥터는 AS2 또는 SFTP 프로토콜을 사용하여 파일을 전송하는 데 사용됩니다. 액세스 역할에는 사용할 AWS Identity and Access Management 역할의 Amazon 리소스 이름 (ARN) 을 제공합니다.

AS2 커넥터의 경우

AS2를 사용하여 StartFileTransfer를 호출하고 요청 파라미터인 SendFilePaths에 파일 경로를 지정하여 파일을 전송할 수 있습니다. 파일의 상위 디렉터리(예: --send-file-paths /bucket/dir/file.txt의 경우 상위 디렉터리는 /bucket/dir/임)를 사용하여 처리된 AS2 메시지 파일을 임시로 저장하고, 파트너로부터 수신 시 MDN을 저장하고, 전송의 관련 메타데이터를 포함하는 최종 JSON 파일을 작성합니다. 따라서 AccessRole은(는) StartFileTransfer 요청에 사용된 파일 위치의 상위 디렉터리에 대한 읽기 및 쓰기 액세스를 제공해야 합니다. 또한 StartFileTransfer와(과) 함께 전송하려는 파일의 상위 디렉터리에 대한 읽기 및 쓰기 액세스 권한을 제공해야 합니다.

AS2 커넥터에 기본 인증을 사용하는 경우 액세스 역할에는 암호에 대한 secretsmanager:GetSecretValue 권한이 필요합니다. Secrets Manager에서 관리 키 대신 고객 AWS 관리 키를 사용하여 암호를 암호화하는 경우 역할에도 해당 키에 대한 kms:Decrypt 권한이 필요합니다.

SFTP 커넥터의 경우

액세스 역할이 StartFileTransfer 요청에서 사용된 파일 위치의 상위 디렉터리에 대한 읽기 및 쓰기 액세스 권한을 제공하는지 확인하세요. 또한 역할이 secretsmanager:GetSecretValue 권한을 제공하는지 확인하십시오. AWS Secrets Manager

타입: 문자열

길이 제약: 최소 길이는 20. 최대 길이는 2,048.

패턴: arn:.*role/\S+

필수 여부: 예

As2Config

AS2 커넥터 객체의 파라미터를 포함하는 구조입니다.

타입: As2ConnectorConfig 객체

필수 항목 여부: 아니요

LoggingRole

커넥터가 Amazon S3 이벤트에 대한 CloudWatch 로깅을 활성화할 수 있도록 하는 AWS Identity and Access Management (IAM) 역할의 Amazon 리소스 이름 (ARN) 입니다. 설정하면 로그에서 커넥터 활동을 볼 수 있습니다. CloudWatch

타입: 문자열

길이 제약: 최소 길이는 20. 최대 길이는 2,048.

패턴: arn:.*role/\S+

Required: No

SecurityPolicyName

커넥터의 보안 정책 이름을 지정합니다.

타입: 문자열

길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 100입니다.

패턴: TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+

필수 여부: 아니요

SftpConfig

SFTP 커넥터 객체의 파라미터를 포함하는 구조입니다.

타입: SftpConnectorConfig 객체

필수 여부: 아니요

Tags

커넥터를 그룹화하고 검색하는 데 사용할 수 있는 키-값 쌍입니다. 태그는 어떠한 목적으로 사용자에게 연결되는 메타데이터입니다.

타입: Tag 객체 배열

배열 멤버: 최소 항목 수는 1개입니다. 최대 항목 수는 50개입니다.

필수 여부: 아니요

Url

파트너의 AS2 또는 SFTP 엔드포인트의 URL입니다.

타입: 문자열

길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 255입니다.

필수 여부: 예

응답 구문


{
   "ConnectorId": "string"
}

응답 요소

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

ConnectorId

커넥터의 고유 식별자로, API 호출 성공 후 반환됩니다.

타입: 문자열

길이 제약 조건: 고정 길이는 19입니다.

패턴: c-([0-9a-f]{17})

Errors

모든 작업에서 발생하는 일반적인 오류에 대한 자세한 내용은 일반적인 오류 섹션을 참조하세요.

InternalServiceError

AWS Transfer Family 서비스에 오류가 발생하면 이 예외가 발생합니다.

HTTP 상태 코드: 500

InvalidRequestException

클라이언트가 잘못된 형식의 요청을 제출하면 이 예외가 발생합니다.

HTTP 상태 코드: 400

ResourceExistsException

요청된 리소스가 존재하지 않거나 명령에 지정된 리전이 아닌 다른 리전에 있습니다.

HTTP 상태 코드: 400

ResourceNotFoundException

AWS Transfer Family 서비스에서 리소스를 찾을 수 없는 경우 이 예외가 발생합니다.

HTTP 상태 코드: 400

ServiceUnavailableException

AWS Transfer Family 서비스를 이용할 수 없어 요청이 실패했습니다.

HTTP 상태 코드: 500

ThrottlingException

요청 제한 때문에 요청이 거부되었습니다.

HTTP 상태 코드: 400

예

다음 예에서는 AS2 커넥터를 생성합니다. 명령에서 다음과 같이 항목을 바꿉니다.

url: 거래 파트너의 AS2 서버의 URL을 제공합니다.
your-IAM-role-for-bucket-access: 파일을 저장하는 데 사용하는 Amazon S3 버킷에 액세스할 수 있는 IAM 역할.
ID가 포함된 로깅 역할에는 ARN을 사용하십시오. AWS 계정
AS2 커넥터 구성 파라미터가 포함된 파일의 경로를 제공하세요. AS2 커넥터 구성 개체는 As2에 설명되어 있습니다. ConnectorConfig


// Listing for testAs2Config.json
{
  "LocalProfileId": "your-profile-id",
  "PartnerProfileId": "partner-profile-id",
  "MdnResponse": "SYNC",
  "Compression": "ZLIB",
  "EncryptionAlgorithm": "AES256_CBC",
  "SigningAlgorithm": "SHA256",
  "MdnSigningAlgorithm": "DEFAULT",
  "MessageSubject": "Your Message Subject"
}


aws transfer create-connector --url "http://partner-as2-server-url" \
          --access-role your-IAM-role-for-bucket-access \
          --logging-role arn:aws:iam::your-account-id:role/service-role/AWSTransferLoggingAccess \
          --as2-config file://path/to/testAS2Config.json

예

다음 예에서는 SFTP 커넥터를 생성합니다. 명령에서 다음과 같이 항목을 바꿉니다.

sftp-server-url: 파일을 교환하는 SFTP 서버의 URL을 제공합니다.
your-IAM-role-for-bucket-access: 파일을 저장하는 데 사용하는 Amazon S3 버킷에 액세스할 수 있는 IAM 역할.
ID가 포함된 로깅 역할에는 ARN을 사용하십시오. AWS 계정
SFTP 커넥터 구성 파라미터가 포함된 파일의 경로를 제공하세요. SFTP 커넥터 구성 개체는 SftpConnectorConfig에 설명되어 있습니다.


// Listing for testSFTPConfig.json
{   
   "UserSecretId": "arn:aws:secretsmanager:us-east-2:123456789012:secret:aws/transfer/example-username-key",
   "TrustedHostKeys": [
      "sftp.example.com ssh-rsa AAAAbbbb...EEEE="
   ]
}


aws transfer create-connector --url "sftp://sftp-server-url" \
--access-role your-IAM-role-for-bucket-access \
--logging-role arn:aws:iam::your-account-id:role/service-role/AWSTransferLoggingAccess \
--sftp-config file://path/to/testSFTPConfig.json

예

API 호출은 새 커넥터의 커넥터 ID를 반환합니다.

샘플 응답


{
    "ConnectorId": "a-11112222333344444"
}

참고

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.

javascript가 브라우저에서 비활성화되거나 사용이 불가합니다.

AWS 설명서를 사용하려면 Javascript가 활성화되어야 합니다. 지침을 보려면 브라우저의 도움말 페이지를 참조하십시오.

문서 규칙

CreateAgreement

CreateProfile