DescribedServer - AWS Transfer Family
Daftar IsiLihat Juga

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

DescribedServer

Menjelaskan properti server berkemampuan protokol transfer file yang ditentukan.

Daftar Isi

Arn

Menentukan Nama Sumber Daya Amazon (ARN) unik dari server.

Jenis: String

Batasan Panjang: Panjang minimum 20. Panjang maksimum 1600.

Pola: arn:\S+

Wajib: Ya

As2ServiceManagedEgressIpAddresses

Daftar alamat IP jalan keluar dari server ini. Alamat IP ini hanya relevan untuk server yang menggunakan protokol AS2. Mereka digunakan untuk mengirim mDNS asinkron.

Alamat IP ini ditetapkan secara otomatis saat Anda membuat server AS2. Selain itu, jika Anda memperbarui server yang ada dan menambahkan protokol AS2, alamat IP statis juga ditetapkan.

Tipe: Array string

Pola: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

Wajib: Tidak

Certificate

Menentukan ARN dari sertifikat Certificate AWS Manager (ACM). Diperlukan saat Protocols diatur ke FTPS.

Jenis: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 1600.

Wajib: Tidak

Domain

Menentukan domain sistem penyimpanan yang digunakan untuk transfer file. Ada dua domain yang tersedia: Amazon Simple Storage Service (Amazon S3) dan Amazon Elastic File System (Amazon EFS). Nilai defaultnya adalah S3.

Jenis: String

Nilai yang Valid: S3 | EFS

Wajib: Tidak

EndpointDetails

Pengaturan titik akhir virtual private cloud (VPC) yang dikonfigurasi untuk server Anda. Ketika Anda meng-host titik akhir Anda dalam VPC Anda, Anda dapat membuat titik akhir Anda hanya dapat diakses oleh sumber daya dalam VPC Anda, atau Anda dapat melampirkan alamat IP Elastis dan membuat titik akhir Anda dapat diakses oleh klien melalui internet. Grup keamanan default VPC Anda secara otomatis ditetapkan ke titik akhir Anda.

Tipe: Objek EndpointDetails

Wajib: Tidak

EndpointType

Mendefinisikan jenis titik akhir yang terhubung dengan server Anda. Jika server Anda terhubung ke titik akhir VPC, server Anda tidak dapat diakses melalui internet publik.

Jenis: String

Nilai yang Valid: PUBLIC | VPC | VPC_ENDPOINT

Wajib: Tidak

HostKeyFingerprint

Menentukan sidik jari SHA256 yang dikodekan Base64 dari kunci host server. Nilai ini setara dengan output dari ssh-keygen -l -f my-new-server-key perintah.

Tipe: String

Wajib: Tidak

IdentityProviderDetails

Menentukan informasi untuk memanggil API otentikasi yang disediakan pelanggan. Bidang ini tidak diisi ketika server AWS_DIRECTORY_SERVICE atauSERVICE_MANAGED. IdentityProviderType

Tipe: Objek IdentityProviderDetails

Wajib: Tidak

IdentityProviderType

Modus otentikasi untuk server. Nilai defaultnya adalahSERVICE_MANAGED, yang memungkinkan Anda untuk menyimpan dan mengakses kredensyal pengguna dalam layanan. AWS Transfer Family

Gunakan AWS_DIRECTORY_SERVICE untuk menyediakan akses ke grup Direktori Aktif di AWS Directory Service for Microsoft Active Directory atau Microsoft Active Directory di lingkungan lokal Anda atau AWS menggunakan AD Connector. Opsi ini juga mengharuskan Anda untuk memberikan ID Direktori dengan menggunakan IdentityProviderDetails parameter.

Gunakan nilai API_GATEWAY untuk mengintegrasikan dengan penyedia identitas pilihan Anda. API_GATEWAYPengaturan mengharuskan Anda untuk menyediakan URL titik akhir Amazon API Gateway untuk memanggil otentikasi dengan menggunakan parameter. IdentityProviderDetails

Gunakan AWS_LAMBDA nilai untuk langsung menggunakan AWS Lambda fungsi sebagai penyedia identitas Anda. Jika Anda memilih nilai ini, Anda harus menentukan ARN untuk fungsi Lambda dalam Function parameter untuk tipe data. IdentityProviderDetails

Jenis: String

Nilai yang Valid: SERVICE_MANAGED | API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA

Wajib: Tidak

LoggingRole

Nama Sumber Daya Amazon (ARN) dari peran AWS Identity and Access Management (IAM) yang memungkinkan server mengaktifkan CloudWatch pencatatan Amazon untuk Amazon S3 atau Amazon EFSevents. Saat disetel, Anda dapat melihat aktivitas pengguna di CloudWatch log Anda.

Jenis: String

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

Pola: (|arn:.*role/\S+)

Wajib: Tidak

PostAuthenticationLoginBanner

Menentukan string untuk ditampilkan ketika pengguna terhubung ke server. String ini ditampilkan setelah pengguna mengautentikasi.

catatan

Protokol SFTP tidak mendukung spanduk tampilan pasca-otentikasi.

Jenis: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 4096.

Pola: [\x09-\x0D\x20-\x7E]*

Wajib: Tidak

PreAuthenticationLoginBanner

Menentukan string untuk ditampilkan ketika pengguna terhubung ke server. String ini ditampilkan sebelum pengguna mengautentikasi. Misalnya, spanduk berikut menampilkan detail tentang penggunaan sistem:

This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

Jenis: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 4096.

Pola: [\x09-\x0D\x20-\x7E]*

Wajib: Tidak

ProtocolDetails

Pengaturan protokol yang dikonfigurasi untuk server Anda.

  • Untuk menunjukkan mode pasif (untuk protokol FTP dan FTPS), gunakan parameter. PassiveIp Masukkan satu alamat IPv4 bertitik quad, seperti alamat IP eksternal dari firewall, router, atau penyeimbang beban.

  • Untuk mengabaikan kesalahan yang dihasilkan saat klien mencoba menggunakan SETSTAT perintah pada file yang Anda unggah ke bucket Amazon S3, gunakan SetStatOption parameternya. Agar AWS Transfer Family server mengabaikan SETSTAT perintah dan mengunggah file tanpa perlu membuat perubahan apa pun pada klien SFTP Anda, tetapkan nilainya. ENABLE_NO_OP Jika Anda menyetel SetStatOption parameternyaENABLE_NO_OP, Transfer Family akan menghasilkan entri CloudWatch log ke Amazon Logs, sehingga Anda dapat menentukan kapan klien melakukan SETSTAT panggilan.

  • Untuk menentukan apakah AWS Transfer Family server Anda melanjutkan sesi terbaru yang dinegosiasikan melalui ID sesi unik, gunakan parameternya. TlsSessionResumptionMode

  • As2Transportsmenunjukkan metode transport untuk pesan AS2. Saat ini, hanya HTTP yang didukung.

Tipe: Objek ProtocolDetails

Wajib: Tidak

Protocols

Menentukan protokol transfer file atau protokol di mana klien protokol transfer file Anda dapat terhubung ke titik akhir server Anda. Protokol yang tersedia adalah:

  • SFTP (Secure Shell (SSH) Protokol Transfer File): Transfer file melalui SSH

  • FTPS (File Transfer Protocol Secure): Transfer file dengan enkripsi TLS

  • FTP (Protokol Transfer File): Transfer file tidak terenkripsi

  • AS2(Pernyataan Penerapan 2): digunakan untuk mengangkut data terstruktur business-to-business

catatan

  • Jika Anda memilihFTPS, Anda harus memilih sertifikat yang disimpan di AWS Certificate Manager (ACM) yang digunakan untuk mengidentifikasi server Anda ketika klien terhubung ke sana melalui FTPS.

  • Jika Protocol termasuk salah satu FTP atauFTPS, maka EndpointType harus VPC dan IdentityProviderType harus baikAWS_DIRECTORY_SERVICE,AWS_LAMBDA, atauAPI_GATEWAY.

  • Jika Protocol termasuk FTP, maka AddressAllocationIds tidak dapat dikaitkan.

  • Jika Protocol disetel hanya keSFTP, EndpointType dapat diatur ke PUBLIC dan IdentityProviderType dapat disetel salah satu jenis identitas yang didukung:SERVICE_MANAGED,AWS_DIRECTORY_SERVICE,AWS_LAMBDA, atauAPI_GATEWAY.

  • Jika Protocol termasukAS2, maka EndpointType harusVPC, dan domain harus Amazon S3.

Tipe: Array string

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

Nilai yang Valid: SFTP | FTP | FTPS | AS2

Wajib: Tidak

S3StorageOptions

Menentukan apakah atau tidak kinerja untuk direktori Amazon S3 Anda dioptimalkan. Ini dinonaktifkan secara default.

Secara default, pemetaan direktori home memiliki TYPE file. DIRECTORY Jika Anda mengaktifkan opsi ini, Anda kemudian perlu secara eksplisit menyetel HomeDirectoryMapEntry Type ke FILE jika Anda ingin pemetaan memiliki target file.

Tipe: Objek S3StorageOptions

Wajib: Tidak

SecurityPolicyName

Menentukan nama kebijakan keamanan untuk server.

Jenis: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 100.

Pola: Transfer[A-Za-z0-9]*SecurityPolicy-[A-Za-z0-9-]+

Wajib: Tidak

ServerId

Menentukan pengidentifikasi unik yang ditetapkan sistem untuk server yang Anda buat instance.

Jenis: String

Kendala Panjang: Panjang tetap 19.

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

Wajib: Tidak

State

Kondisi server yang dijelaskan. Nilai ONLINE menunjukkan bahwa server dapat menerima pekerjaan dan mentransfer file. StateNilai OFFLINE berarti bahwa server tidak dapat melakukan operasi transfer file.

Status STARTING dan STOPPING menunjukkan bahwa server berada dalam keadaan perantara, baik tidak sepenuhnya dapat merespons, atau tidak sepenuhnya offline. Nilai START_FAILED atau STOP_FAILED dapat menunjukkan kondisi kesalahan.

Jenis: String

Nilai yang Valid: OFFLINE | ONLINE | STARTING | STOPPING | START_FAILED | STOP_FAILED

Wajib: Tidak

StructuredLogDestinations

Menentukan grup log yang log server Anda dikirim.

Untuk menentukan grup log, Anda harus memberikan ARN untuk grup log yang ada. Dalam hal ini, format grup log adalah sebagai berikut:

arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*

Misalnya, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

Jika sebelumnya Anda telah menentukan grup log untuk server, Anda dapat menghapusnya, dan pada dasarnya mematikan logging terstruktur, dengan memberikan nilai kosong untuk parameter ini dalam update-server panggilan. Sebagai contoh:

update-server --server-id s-1234567890abcdef0 --structured-log-destinations

Tipe: Array string.

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

Batasan Panjang: Panjang minimum 20. Panjang maksimum 1600.

Pola: arn:\S+

Wajib: Tidak

Tags

Menentukan pasangan kunci-nilai yang dapat Anda gunakan untuk mencari dan mengelompokkan server yang ditugaskan ke server yang dijelaskan.

Tipe: Array objek Tag

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

Wajib: Tidak

UserCount

Menentukan jumlah pengguna yang ditugaskan ke server yang Anda tentukan dengan. ServerId

Tipe: Integer

Wajib: Tidak

WorkflowDetails

Menentukan ID alur kerja untuk alur kerja yang akan ditetapkan dan peran eksekusi yang digunakan untuk mengeksekusi alur kerja.

Selain alur kerja untuk mengeksekusi ketika file diunggah sepenuhnya, juga WorkflowDetails dapat berisi ID alur kerja (dan peran eksekusi) untuk alur kerja untuk mengeksekusi pada upload sebagian. Upload sebagian terjadi ketika sesi server terputus saat file masih diunggah.

Tipe: Objek WorkflowDetails

Wajib: Tidak

Lihat Juga

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