UpdateServer

Memperbarui properti server berkemampuan protokol transfer file setelah server tersebut dibuat.

UpdateServerPanggilan mengembalikan server ServerId yang Anda perbarui.

Sintaksis Permintaan

{
   "Certificate": "string",
   "EndpointDetails": { 
      "AddressAllocationIds": [ "string" ],
      "SecurityGroupIds": [ "string" ],
      "SubnetIds": [ "string" ],
      "VpcEndpointId": "string",
      "VpcId": "string"
   },
   "EndpointType": "string",
   "HostKey": "string",
   "IdentityProviderDetails": { 
      "DirectoryId": "string",
      "Function": "string",
      "InvocationRole": "string",
      "SftpAuthenticationMethods": "string",
      "Url": "string"
   },
   "LoggingRole": "string",
   "PostAuthenticationLoginBanner": "string",
   "PreAuthenticationLoginBanner": "string",
   "ProtocolDetails": { 
      "As2Transports": [ "string" ],
      "PassiveIp": "string",
      "SetStatOption": "string",
      "TlsSessionResumptionMode": "string"
   },
   "Protocols": [ "string" ],
   "S3StorageOptions": { 
      "DirectoryListingOptimization": "string"
   },
   "SecurityPolicyName": "string",
   "ServerId": "string",
   "StructuredLogDestinations": [ "string" ],
   "WorkflowDetails": { 
      "OnPartialUpload": [ 
         { 
            "ExecutionRole": "string",
            "WorkflowId": "string"
         }
      ],
      "OnUpload": [ 
         { 
            "ExecutionRole": "string",
            "WorkflowId": "string"
         }
      ]
   }
}

Parameter Permintaan

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

Permintaan menerima data berikut dalam format JSON.

Certificate

Nama Sumber Daya Amazon (ARN) dari AWS sertifikat Certificate Manager (ACM). Diperlukan saat Protocols diatur ke FTPS.

Untuk meminta sertifikat publik baru, lihat Meminta sertifikat publik di Panduan Pengguna AWS Certificate Manager.

Untuk mengimpor sertifikat yang ada ke ACM, lihat Mengimpor sertifikat ke ACM di Panduan Pengguna AWS Certificate Manager.

Untuk meminta sertifikat pribadi menggunakan FTPS melalui alamat IP pribadi, lihat Meminta sertifikat pribadi di Panduan Pengguna AWS Certificate Manager.

Sertifikat dengan algoritme kriptografi dan ukuran kunci berikut didukung:

• 2048-bit RSA (RSA_2048)

• 4096-bit RSA (RSA_4096)

• Elliptic Prime Curve 256 bit (EC_prime256v1)

• Elliptic Prime Curve 384 bit (EC_secp384r1)

• Elliptic Prime Curve 521 bit (EC_secp521r1)

catatan

Sertifikat harus berupa sertifikat SSL/TLS X.509 versi 3 yang valid dengan FQDN atau alamat IP yang ditentukan dan informasi tentang penerbitnya.

Jenis: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 1600.

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

Jenis endpoint yang Anda ingin server Anda gunakan. Anda dapat memilih untuk membuat endpoint server Anda dapat diakses publik (PUBLIK) atau menghostingnya di dalam VPC Anda. Dengan endpoint yang di-host di VPC, Anda dapat membatasi akses ke server dan sumber daya hanya dalam VPC Anda atau memilih untuk membuatnya menghadap internet dengan melampirkan alamat IP Elastis langsung ke sana.

catatan

Setelah 19 Mei 2021, Anda tidak akan dapat membuat server menggunakan EndpointType=VPC_ENDPOINT di AWS akun Anda jika akun Anda belum melakukannya sebelum 19 Mei 2021. Jika Anda telah membuat server dengan EndpointType=VPC_ENDPOINT di AWS akun Anda pada atau sebelum 19 Mei 2021, Anda tidak akan terpengaruh. Setelah tanggal ini, gunakan EndpointType =VPC.

Untuk informasi selengkapnya, lihat Menghentikan penggunaan VPC_ENDPOINT.

Direkomendasikan agar Anda menggunakan VPC sebagai EndpointType. Dengan jenis titik akhir ini, Anda memiliki pilihan untuk secara langsung mengaitkan hingga tiga alamat IPv4 Elastis (termasuk IP BYO) dengan titik akhir server Anda dan menggunakan grup keamanan VPC untuk membatasi lalu lintas berdasarkan alamat IP publik klien. Hal ini tidak mungkin terjadi jika EndpointType diatur ke VPC_ENDPOINT.

Jenis: String

Nilai yang Valid: PUBLIC | VPC | VPC_ENDPOINT

Wajib: Tidak

HostKey

Kunci pribadi RSA, ECDSA, atau ED25519 untuk digunakan untuk server berkemampuan SFTP Anda. Anda dapat menambahkan beberapa kunci host, jika Anda ingin memutar tombol, atau memiliki satu set kunci aktif yang menggunakan algoritma yang berbeda.

Gunakan perintah berikut untuk menghasilkan kunci RSA 2048 bit tanpa frasa sandi:

ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key.

Gunakan nilai minimum 2048 untuk -b opsi. Anda dapat membuat kunci yang lebih kuat dengan menggunakan 3072 atau 4096.

Gunakan perintah berikut untuk menghasilkan kunci ECDSA 256 bit tanpa frasa sandi:

ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key.

Nilai yang valid untuk -b opsi ECDSA adalah 256, 384, dan 521.

Gunakan perintah berikut untuk menghasilkan kunci ED25519 tanpa frasa sandi:

ssh-keygen -t ed25519 -N "" -f my-new-server-key.

Untuk semua perintah ini, Anda dapat mengganti my-new-server-keydengan string pilihan Anda.

penting

Jika Anda tidak berencana untuk memigrasikan pengguna yang ada dari server berkemampuan SFTP yang sudah ada ke server baru, jangan perbarui kunci host. Mengubah kunci host server secara tidak sengaja dapat mengganggu.

Untuk informasi selengkapnya, lihat Memperbarui kunci host untuk server berkemampuan SFTP di Panduan Pengguna. AWS Transfer Family

Jenis: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 4096.

Wajib: Tidak

IdentityProviderDetails

Array yang berisi semua informasi yang diperlukan untuk memanggil metode API otentikasi pelanggan.

Tipe: Objek IdentityProviderDetails

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

Pengidentifikasi unik yang ditetapkan sistem untuk instance server yang ditetapkan oleh pengguna Transfer Family.

Jenis: String

Kendala Panjang: Panjang tetap 19.

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

Wajib: Ya

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

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.

Untuk menghapus alur kerja terkait dari server, Anda dapat memberikan OnUpload objek kosong, seperti pada contoh berikut.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

Tipe: Objek WorkflowDetails

Wajib: Tidak

Sintaksis Respons

{
   "ServerId": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

ServerId

Pengidentifikasi unik yang ditetapkan sistem untuk server yang ditetapkan oleh pengguna Transfer Family.

Jenis: String

Kendala Panjang: Panjang tetap 19.

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

Kesalahan

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

AccessDeniedException

Anda tidak memiliki akses yang memadai untuk melakukan tindakan ini.

Kode Status HTTP: 400

ConflictException

Pengecualian ini dilemparkan ketika UpdateServer dipanggil untuk server berkemampuan protokol transfer file yang memiliki VPC sebagai tipe titik akhir dan server tidak dalam keadaan VpcEndpointID tersedia.

Kode Status HTTP: 400

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 memperbarui peran server.

Permintaan Sampel

{
   "EndpointDetails": { 
   "VpcEndpointId": "vpce-01234f056f3g13",
   "LoggingRole": "CloudWatchS3Events",
   "ServerId": "s-01234567890abcdef"
   }
}

Contoh

Contoh berikut menghapus alur kerja terkait dari server.

Permintaan Sampel

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

Contoh

Ini adalah contoh respons untuk panggilan API ini.

Contoh Respons

{
   "ServerId": "s-01234567890abcdef"
}

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