UpdateLocationObjectStorage - AWS DataSync

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

UpdateLocationObjectStorage

使用しているオブジェクトストレージ転送場所の次の設定パラメータを変更します AWS DataSync。

詳細については、「オブジェクトストレージシステムを使用した DataSync 転送の設定」を参照してください。

リクエストの構文

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

リクエストパラメーター

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

リクエストは以下のデータを JSON 形式で受け入れます。

AccessKey

オブジェクトストレージサーバーとの認証に認証情報が必要な場合、アクセスキー (ユーザー名など) を指定します。

タイプ: 文字列

長さの制約: 最小長は 0 です。最大長は 200 です。

パターン: ^.*$

必須: いいえ

AgentArns

(オプション) オブジェクトストレージシステムに接続できる DataSync エージェントの Amazon リソースネーム (ARNs) を指定します。エージェントレスクロスクラウド転送を設定する場合は、このパラメータの値を指定する必要はありません。

注記

ストレージロケーションを最初に作成した後は、エージェントを追加または削除することはできません。

型: 文字列の配列

配列メンバー: 最小数は 1 項目です。最大数は 4 項目です。

長さの制約: 最大長は 128 です。

パターン: ^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}$

必須: いいえ

CmkSecretConfig

DataSync が特定の転送場所へのアクセスに使用する認証トークンや認証情報のセット、カスタマーマネージドなど、DataSync が管理するシークレットの設定情報を指定します AWS KMS key。

型: CmkSecretConfig オブジェクト

必須: いいえ

CustomSecretConfig

DataSync が特定の転送場所へのアクセスに使用する認証トークンや認証情報のセット、およびカスタマー管理のシークレットの設定情報を指定します AWS KMS key。

型: CustomSecretConfig オブジェクト

必須: いいえ

LocationArn

更新するオブジェクトストレージシステムの場所の ARN を指定します。

タイプ: 文字列

長さの制約: 最大長は 128 です。

パターン: ^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}$

必須: はい

SecretKey

オブジェクトストレージサーバーとの認証に認証情報が必要な場合、秘密鍵 (パスワードなど) を指定します。

注記

を使用してシークレットを指定しSecretKeyCmkSecretConfigまたは を使用してシークレット設定の詳細を指定しない場合CustomSecretConfig、DataSync は AWS アカウントの Secrets Manager シークレットを使用してトークンを保存します。

タイプ: 文字列

長さの制約: 最小長は 0 です。最大長は 200 です。

パターン: ^.*$

必須: いいえ

ServerCertificate

オブジェクトストレージシステムがプライベートまたは自己署名の認証機関 (CA) を使用する場合、DataSync がそのシステムで認証するための証明書チェーンを指定します。完全な証明書チェーンを持つ .pem ファイルを 1 つ指定する必要があります (例: file:///home/user/.ssh/object_storage_certificates.pem)。

証明書チェーンには以下が含まれます。

  • オブジェクトストレージシステムの証明書

  • すべての中間証明書 (存在する場合)

  • 署名 CA のルート証明書

証明書を .pem ファイルに連結できます (base64 エンコーディングの前は最大 32,768 バイトまで可能)。次の cat コマンド例では、3 つの証明書を含む object_storage_certificates.pem ファイルを作成します。

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

このパラメータを使用するには、ServerProtocolHTTPS に構成します。

このパラメータの更新によって、進行中のタスクが妨げられることはありません。

タイプ: Base64 でエンコードされたバイナリデータオブジェクト

長さの制約: 最大長は 32,768 です。

必須: いいえ

ServerHostname

DataSync エージェントが接続するオブジェクトストレージサーバーのドメイン名または IP バージョン 4 (IPv4) アドレスを指定します。

タイプ: 文字列

長さの制約: 最大長は 255 です。

パターン: ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$

必須: いいえ

ServerPort

オブジェクトストレージサーバーがインバウンドネットワークトラフィックを受け入れるポート (ポート 443 など) を指定します。

タイプ: 整数

有効範囲: 最小値 は 1 です。最大値は 65,536 です。

必須: いいえ

ServerProtocol

オブジェクトストレージサーバーが通信に使用するプロトコルを指定します。

タイプ: 文字列

有効な値:HTTPS | HTTP

必須: いいえ

Subdirectory

オブジェクトストレージサーバーのオブジェクトプレフィックスを指定します。これがソースの場所である場合、DataSync はこのプレフィックスを持つオブジェクトのみをコピーします。これが送信先の場所である場合、DataSync は、このプレフィックスを持つすべてのオブジェクトを書き込みます。

タイプ: 文字列

長さの制約: 最大長は 4,096 です。

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

必須: いいえ

レスポンス要素

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

InternalException

この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。

HTTP ステータスコード: 500

InvalidRequestException

この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。

HTTP ステータスコード: 400

以下の資料も参照してください。

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。