CreateLocationObjectStorage

オブジェクトストレージシステムの転送場所を作成します。AWS DataSync は、この場所をデータ転送のソースまたは転送先として使用できます。DataSync エージェントの有無にかかわらず転送を行うことができます。

始める前に、DataSync がオブジェクトストレージシステムで動作するための前提条件を理解していることを確認してください。

リクエストの構文

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

リクエストパラメータ

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

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

AccessKey

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

タイプ: 文字列

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

パターン: ^.*$

必須: いいえ

AgentArns

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

注記

初めてストレージの場所を作成する際は、必ずこのパラメータを正しく設定してください。作成後にストレージの場所からエージェントを追加または削除することはできません。

型: 文字列の配列

配列メンバー: 最小数は 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}$

必須: いいえ

BucketName

転送に関係するオブジェクトストレージバケットの名前を指定します。

タイプ: 文字列

長さの制約: 最小長は 3 です。最大長は 63 です。

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

必須: はい

CmkSecretConfig

DataSync が管理するシークレットの設定情報を指定します。これには、DataSync が特定のオブジェクトストレージの場所にアクセスするために使用する SecretKey と、カスタマー管理の AWS KMS keyが含まれます。

このパラメータを CreateLocationObjectStorage リクエストの一部として含める場合は、KMS キー ARN のみを指定します。DataSync は、SecretKey パラメータに指定された値とともにこの KMS キーを使用して、DataSync が管理するシークレットを作成し、場所にアクセスするための認証情報を保存します。

DataSync に、指定した KMS キーへのアクセス許可があることを確認します。

注記

CmkSecretConfig (SecretKey あり) または CustomSecretConfig (SecretKey なし) を使用して、CreateLocationObjectStorage リクエストの認証情報を指定できます。同じリクエストに対して両方のパラメータを指定しないでください。

型: CmkSecretConfig オブジェクト

必須: いいえ

CustomSecretConfig

特定のオブジェクトストレージの場所のシークレットキーがプレーンテキストで保存される、カスタマー管理の Secrets Manager シークレットの設定情報を指定します。この設定には、シークレット ARN、およびシークレットへのアクセスを提供する IAM ロールの ARN が含まれます。

注記

CmkSecretConfig (SecretKey あり) または CustomSecretConfig (SecretKey なし) を使用して、CreateLocationObjectStorage リクエストの認証情報を指定できます。同じリクエストに対して両方のパラメータを指定しないでください。

型: CustomSecretConfig オブジェクト

必須: いいえ

SecretKey

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

注記

SecretKey を使用してシークレットを指定したものの、CmkSecretConfig または 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

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

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

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

必須: いいえ

ServerHostname

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

タイプ: 文字列

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

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

必須: はい

ServerPort

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

タイプ: 整数

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

必須: いいえ

ServerProtocol

オブジェクトストレージサーバーが通信に使用するプロトコルを指定します。指定されなかった場合、デフォルト値は HTTPS です。

型: 文字列

有効な値：HTTPS | HTTP

必須: いいえ

Subdirectory

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

タイプ: 文字列

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

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

必須: いいえ

Tags

リソースに追加するタグを表すキーと値のペアを指定します。タグは、リソースの管理、フィルタリング、検索に役立ちます。場所の名前タグを作成することを推奨します。

タイプ: TagListEntry オブジェクトの配列

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

必須: いいえ

レスポンスの構文

{
   "LocationArn": "string"
}

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

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}$

エラー

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

InternalException

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

HTTP ステータスコード: 500

InvalidRequestException

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

HTTP ステータスコード: 400

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

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

• AWS Command Line Interface V2

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for Kotlin

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3