CreateConnector - AWS Transfer Family

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

CreateConnector

AS2 또는 SFTP 프로토콜에 대한 연결 파라미터를 캡처하는 커넥터를 생성합니다. AS2의 경우 외부 호스팅 AS2 서버로 파일을 전송하려면 커넥터가 필요합니다. 의 경우 SFTP서버로 파일을 보내거나 SFTP 서버에서 파일을 수신할 때 커넥터가 필요합니다SFTP. 커넥터에 대한 자세한 내용은 AS2 커넥터 구성 SFTP 커넥터 생성 단원을 참조하세요.

참고

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

구문 요청

{ "AccessRole": "string", "As2Config": { "BasicAuthSecretId": "string", "Compression": "string", "EncryptionAlgorithm": "string", "LocalProfileId": "string", "MdnResponse": "string", "MdnSigningAlgorithm": "string", "MessageSubject": "string", "PartnerProfileId": "string", "SigningAlgorithm": "string" }, "LoggingRole": "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 커넥터의 경우

를 사용하면 를 호출StartFileTransfer하고 요청 파라미터 에서 파일 경로를 지정하여 파일을 보낼 AS2수 있습니다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.

Pattern: arn:.*role/\S+

필수 여부: 예

As2Config

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

유형: As2ConnectorConfig 객체

필수 여부: 아니요

LoggingRole

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

유형: 문자열

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

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

Required: No

SftpConfig

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

유형: SftpConnectorConfig 객체

필수 여부: 아니요

Tags

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

타입: Tag 객체 배열

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

필수 여부: 아니요

Url

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

유형: 문자열

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

필수 여부: 예

응답 구문

{ "ConnectorId": "string" }

Response Elements

작업이 성공하면 서비스가 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 역할입니다.

  • AWS 계정 ID가 포함된 로깅 역할에 ARN 를 사용합니다.

  • AS2 커넥터 구성 파라미터가 포함된 파일의 경로를 제공합니다. AS2 커넥터 구성 객체는 As2ConnectorConfig에 설명되어 있습니다.

// 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 역할입니다.

  • AWS 계정 ID가 포함된 로깅 역할에 ARN 를 사용합니다.

  • 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" }

참고

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