CreateLocationObjectStorage - AWS DataSync
Sintaksis PermintaanParameter PermintaanSintaksis ResponsElemen ResponsKesalahanLihat Juga

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

CreateLocationObjectStorage

Membuat lokasi transfer untuk sistem penyimpanan objek. AWS DataSync dapat menggunakan lokasi ini sebagai sumber atau tujuan untuk mentransfer data. Anda dapat melakukan transfer dengan atau tanpa DataSyncagen.

Sebelum Anda mulai, pastikan Anda memahami prasyarat DataSync untuk bekerja dengan sistem penyimpanan objek.

Sintaksis Permintaan

{
   "AccessKey": "string",
   "AgentArns": [ "string" ],
   "BucketName": "string",
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "SecretKey": "string",
   "ServerCertificate": blob,
   "ServerHostname": "string",
   "ServerPort": number,
   "ServerProtocol": "string",
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Parameter Permintaan

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

Permintaan menerima data berikut dalam format JSON.

AccessKey

Menentukan kunci akses (misalnya, nama pengguna) jika kredensil diperlukan untuk mengautentikasi dengan server penyimpanan objek.

Tipe: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 200.

Pola: ^.*$

Wajib: Tidak

AgentArns

(Opsional) Menentukan Nama Sumber Daya Amazon (ARNs) dari DataSync agen yang dapat terhubung dengan sistem penyimpanan objek Anda. Jika Anda menyiapkan transfer lintas cloud tanpa agen, Anda tidak perlu menentukan nilai untuk parameter ini.

catatan

Pastikan Anda mengonfigurasi parameter ini dengan benar saat pertama kali membuat lokasi penyimpanan. Anda tidak dapat menambah atau menghapus agen dari lokasi penyimpanan setelah Anda membuatnya.

Tipe: Array string

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

Batasan Panjang: Panjang maksimum 128.

Pola: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$

Wajib: Tidak

BucketName

Menentukan nama bucket penyimpanan objek yang terlibat dalam transfer.

Tipe: String

Batasan Panjang: Panjang minimum 3. Panjang maksimum 63.

Pola: ^[a-zA-Z0-9_\-\+\.\(\)\$\p{Zs}]+$

Wajib: Ya

CmkSecretConfig

Menentukan informasi konfigurasi untuk rahasia DataSync -managed, yang mencakup SecretKey yang DataSync digunakan untuk mengakses lokasi penyimpanan objek tertentu, dengan yang dikelola pelanggan. AWS KMS key

Ketika Anda menyertakan paramater ini sebagai bagian dari CreateLocationObjectStorage permintaan, Anda hanya memberikan ARN kunci KMS. DataSync menggunakan kunci KMS ini bersama dengan nilai yang Anda tentukan untuk SecretKey parameter untuk membuat rahasia DataSync -managed untuk menyimpan kredenal akses lokasi.

Pastikan DataSync memiliki izin untuk mengakses kunci KMS yang Anda tentukan.

catatan

Anda dapat menggunakan CmkSecretConfig (withSecretKey) atau CustomSecretConfig (withoutSecretKey) untuk memberikan kredensi untuk permintaan. CreateLocationObjectStorage Jangan berikan kedua parameter untuk permintaan yang sama.

Tipe: Objek CmkSecretConfig

Wajib: Tidak

CustomSecretConfig

Menentukan informasi konfigurasi untuk rahasia Secrets Manager yang dikelola pelanggan di mana kunci rahasia untuk lokasi penyimpanan objek tertentu disimpan dalam teks biasa. Konfigurasi ini mencakup ARN rahasia, dan ARN untuk peran IAM yang menyediakan akses ke rahasia.

catatan

Anda dapat menggunakan CmkSecretConfig (withSecretKey) atau CustomSecretConfig (withoutSecretKey) untuk memberikan kredensi untuk permintaan. CreateLocationObjectStorage Jangan berikan kedua parameter untuk permintaan yang sama.

Tipe: Objek CustomSecretConfig

Wajib: Tidak

SecretKey

Menentukan kunci rahasia (misalnya, kata sandi) jika kredensil diperlukan untuk mengautentikasi dengan server penyimpanan objek.

catatan

Jika Anda memberikan rahasia menggunakanSecretKey, tetapi tidak memberikan rincian konfigurasi rahasia menggunakan CmkSecretConfig atauCustomSecretConfig, kemudian DataSync menyimpan token menggunakan rahasia Secrets Manager AWS akun Anda.

Tipe: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 200.

Pola: ^.*$

Wajib: Tidak

ServerCertificate

Menentukan rantai sertifikat DataSync untuk mengautentikasi dengan sistem penyimpanan objek Anda jika sistem menggunakan otoritas sertifikat pribadi atau yang ditandatangani sendiri (CA). Anda harus menentukan satu .pem file dengan rantai sertifikat lengkap (misalnya,file:///home/user/.ssh/object_storage_certificates.pem).

Rantai sertifikat mungkin termasuk:

  • Sertifikat sistem penyimpanan objek

  • Semua sertifikat perantara (jika ada)

  • Sertifikat root dari CA penandatanganan

Anda dapat menggabungkan sertifikat Anda ke dalam .pem file (yang dapat mencapai 32768 byte sebelum pengkodean base64). Contoh cat perintah berikut membuat object_storage_certificates.pem file yang mencakup tiga sertifikat:

cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem

Untuk menggunakan parameter ini, konfigurasikan ServerProtocol keHTTPS.

Tipe: Objek data biner dienkode Base64

Kendala Panjang: Panjang maksimum 32768.

Wajib: Tidak

ServerHostname

Menentukan nama domain atau alamat IP versi 4 (IPv4) dari server penyimpanan objek yang terhubung dengan DataSync agen Anda.

Tipe: String

Batasan Panjang: Panjang maksimum 255.

Pola: ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$

Wajib: Ya

ServerPort

Menentukan port tempat server penyimpanan objek Anda menerima lalu lintas jaringan masuk (misalnya, port 443).

Tipe: Bilangan Bulat

Rentang yang Valid: Nilai minimum 1. Nilai maksimum 65536.

Wajib: Tidak

ServerProtocol

Menentukan protokol yang digunakan server penyimpanan objek Anda untuk berkomunikasi. Jika tidak ditentukan, nilai defaultnya adalahHTTPS.

Tipe: String

Nilai yang Valid: HTTPS | HTTP

Wajib: Tidak

Subdirectory

Menentukan awalan objek untuk server penyimpanan objek Anda. Jika ini adalah lokasi sumber, DataSync hanya menyalin objek dengan awalan ini. Jika ini adalah lokasi tujuan, DataSync tulis semua objek dengan awalan ini.

Tipe: String

Batasan Panjang: Panjang maksimum 4096.

Pola: ^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$

Wajib: Tidak

Tags

Menentukan pasangan kunci-nilai yang mewakili tag yang ingin Anda tambahkan ke sumber daya. Tag dapat membantu Anda mengelola, memfilter, dan mencari sumber daya Anda. Sebaiknya buat tag nama untuk lokasi Anda.

Tipe: Array objek TagListEntry

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

Diperlukan: Tidak

Sintaksis Respons

{
   "LocationArn": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

LocationArn

Menentukan ARN dari lokasi sistem penyimpanan objek yang Anda buat.

Tipe: String

Batasan Panjang: Panjang maksimum 128.

Pola: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

Kesalahan

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

InternalException

Pengecualian ini dilontarkan ketika terjadi kesalahan dalam layanan AWS DataSync .

Kode Status HTTP: 500

InvalidRequestException

Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.

Kode Status HTTP: 400

Lihat Juga

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