CreateConnector

Membuat konektor, yang menangkap parameter untuk koneksi untuk protokol AS2 atau SFTP. Untuk AS2, konektor diperlukan untuk mengirim file ke server AS2 yang dihosting secara eksternal. Untuk SFTP, konektor diperlukan saat mengirim file ke server SFTP atau menerima file dari server SFTP. Untuk detail selengkapnya tentang konektor, lihat Mengkonfigurasi konektor AS2 dan Membuat konektor SFTP.

catatan

Anda harus menentukan tepat satu objek konfigurasi: baik untuk AS2 (As2Config) atau SFTP (). SftpConfig

Sintaksis Permintaan

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

Parameter Permintaan

Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.

Permintaan menerima data berikut dalam format JSON.

AccessRole

Konektor digunakan untuk mengirim file menggunakan protokol AS2 atau SFTP. Untuk peran akses, berikan Nama Sumber Daya Amazon (ARN) AWS Identity and Access Management peran yang akan digunakan.

Untuk konektor AS2

Dengan AS2, Anda dapat mengirim file dengan memanggil StartFileTransfer dan menentukan jalur file dalam parameter permintaan,. SendFilePaths Kami menggunakan direktori induk file (misalnya, untuk, direktori induk/bucket/dir/) untuk --send-file-paths /bucket/dir/file.txt sementara menyimpan file pesan AS2 yang diproses, menyimpan MDN ketika kami menerimanya dari mitra, dan menulis file JSON akhir yang berisi metadata transmisi yang relevan. Jadi, AccessRole kebutuhan untuk menyediakan akses baca dan tulis ke direktori induk dari lokasi file yang digunakan dalam StartFileTransfer permintaan. Selain itu, Anda perlu menyediakan akses baca dan tulis ke direktori induk dari file yang ingin Anda kirimStartFileTransfer.

Jika Anda menggunakan otentikasi Dasar untuk konektor AS2 Anda, peran akses memerlukan secretsmanager:GetSecretValue izin untuk rahasia tersebut. Jika rahasia dienkripsi menggunakan kunci yang dikelola pelanggan alih-alih kunci yang dikelola di AWS Secrets Manager, maka peran tersebut juga memerlukan kms:Decrypt izin untuk kunci tersebut.

Untuk konektor SFTP

Pastikan bahwa peran akses menyediakan akses baca dan tulis ke direktori induk dari lokasi file yang digunakan dalam StartFileTransfer permintaan. Selain itu, pastikan bahwa peran tersebut memberikan secretsmanager:GetSecretValue izin untuk AWS Secrets Manager.

Jenis: String

Batasan Panjang: Panjang minimum 20. Panjang maksimum 2048.

Pola: arn:.*role/\S+

Wajib: Ya

As2Config

Struktur yang berisi parameter untuk objek konektor AS2.

Tipe: Objek As2ConnectorConfig

Wajib: Tidak

LoggingRole

Nama Sumber Daya Amazon (ARN) dari peran AWS Identity and Access Management (IAM) yang memungkinkan konektor mengaktifkan CloudWatch logging untuk peristiwa Amazon S3. Saat disetel, Anda dapat melihat aktivitas konektor di CloudWatch log Anda.

Jenis: String

Batasan Panjang: Panjang minimum 20. Panjang maksimum 2048.

Pola: arn:.*role/\S+

Wajib: Tidak

SecurityPolicyName

Menentukan nama kebijakan keamanan untuk konektor.

Jenis: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 100.

Pola: TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+

Wajib: Tidak

SftpConfig

Struktur yang berisi parameter untuk objek konektor SFTP.

Tipe: Objek SftpConnectorConfig

Wajib: Tidak

Tags

Pasangan nilai kunci yang dapat digunakan untuk mengelompokkan dan mencari konektor. Tag adalah metadata yang terpasang pada konektor untuk tujuan apa pun.

Tipe: Array objek Tag

Anggota Array: Jumlah minimum 1 item. Jumlah maksimum 50 item.

Wajib: Tidak

Url

URL titik akhir AS2 atau SFTP mitra.

Jenis: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum sebesar 255.

Wajib: Ya

Sintaksis Respons

{
   "ConnectorId": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

ConnectorId

Pengenal unik untuk konektor, dikembalikan setelah panggilan API berhasil.

Jenis: String

Kendala Panjang: Panjang tetap 19.

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

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

InternalServiceError

Pengecualian ini dilemparkan ketika kesalahan terjadi dalam AWS Transfer Family layanan.

Kode Status HTTP: 500

InvalidRequestException

Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.

Kode Status HTTP: 400

ResourceExistsException

Sumber daya yang diminta tidak ada, atau ada di wilayah selain yang ditentukan untuk perintah.

Kode Status HTTP: 400

ResourceNotFoundException

Pengecualian ini dilemparkan ketika sumber daya tidak ditemukan oleh layanan AWS Transfer Family.

Kode Status HTTP: 400

ServiceUnavailableException

Permintaan gagal karena layanan AWS Transfer Family tidak tersedia.

Kode Status HTTP: 500

ThrottlingException

Permintaan ditolak karena throttling permintaan.

Kode Status HTTP: 400

Contoh

Contoh

Contoh berikut membuat konektor AS2. Dalam perintah, ganti item sebagai berikut:

• url: berikan URL untuk server AS2 mitra dagang.

• your-IAM-role-for-bucket-access: peran IAM yang memiliki akses ke bucket Amazon S3 yang Anda gunakan untuk menyimpan file Anda.

• Gunakan ARN untuk peran logging Anda, yang menyertakan ID Anda Akun AWS .

• Berikan path ke file yang berisi parameter konfigurasi konektor AS2. Objek konfigurasi konektor AS2 dijelaskan dalam ConnectorConfigAs2.

// 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

Contoh

Contoh berikut membuat konektor SFTP. Dalam perintah, ganti item sebagai berikut:

• sftp-server-url: berikan URL untuk server SFTP tempat Anda bertukar file.

• your-IAM-role-for-bucket-access: peran IAM yang memiliki akses ke bucket Amazon S3 yang Anda gunakan untuk menyimpan file Anda.

• Gunakan ARN untuk peran logging Anda, yang menyertakan ID Anda Akun AWS .

• Berikan jalur ke file yang berisi parameter konfigurasi konektor SFTP. Objek konfigurasi konektor SFTP dijelaskan dalam ConfigSftpConnector.

// 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

Contoh

Panggilan API mengembalikan ID konektor untuk konektor baru.

Contoh Respons

{
    "ConnectorId": "a-11112222333344444"
}

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini:

• AWS Antarmuka Baris Perintah

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK untuk V3 JavaScript

• AWS SDK for PHP V3

• AWS SDK untuk Python

• AWS SDK for Ruby V3