CreateLocationHdfs - AWS DataSync

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

CreateLocationHdfs

Hadoop Distributed File System (HDFS) の転送場所を作成します。 AWS DataSync は、この場所をデータ転送のソースまたは送信先として使用できます。

始める前に、必ず DataSync がどのように HDFS クラスターにアクセスするかを理解してください。

リクエストの構文

{ "AgentArns": [ "string" ], "AuthenticationType": "string", "BlockSize": number, "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "KerberosKeytab": blob, "KerberosKrb5Conf": blob, "KerberosPrincipal": "string", "KmsKeyProviderUri": "string", "NameNodes": [ { "Hostname": "string", "Port": number } ], "QopConfiguration": { "DataTransferProtection": "string", "RpcProtection": "string" }, "ReplicationFactor": number, "SimpleUser": "string", "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

リクエストパラメーター

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

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

AgentArns

HDFS クラスターに接続できる DataSync エージェントの Amazon リソースネーム (ARN)。

タイプ: 文字列の配列

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

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

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

必須: はい

AuthenticationType

ユーザーの ID を決定するために使用される認証のタイプ。

タイプ: 文字列

有効な値:SIMPLE | KERBEROS

必須: はい

BlockSize

HDFS クラスターに書き込むデータブロックのサイズ。ブロックサイズは 512 バイトの倍数にする必要があります。デフォルトのブロックサイズは 128 メガバイト (MiB) です。

タイプ: 整数

有効範囲: 最小値 は 1,048,576 です。最大値は 1,073,741,824 です。

必須: いいえ

CmkSecretConfig

DataSync が管理するシークレットの設定情報を指定します。これには、DataSync がカスタマーマネージドで特定の Hadoop Distributed File System (HDFS) ストレージの場所にアクセスするために使用する Kerberos キータブが含まれます AWS KMS key。

このパラメータをCreateLocationHdfsリクエストの一部として含める場合は、KMS キー ARN のみを指定します。DataSync は、この KMS キーを にKerberosKeytab指定した とともに使用して、ロケーションアクセス認証情報を保存する DataSync マネージドシークレットを作成します。

DataSync に、指定した KMS キーへのアクセス許可があることを確認します。詳細については、「カスタムで暗号化されたサービスマネージドシークレットの使用 AWS KMS key」を参照してください。

注記

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

型: CmkSecretConfig オブジェクト

必須: いいえ

CustomSecretConfig

HDFS ストレージの場所の Kerberos キータブが Secrets Manager のバイナリに保存されている、カスタマー管理の Secrets Manager シークレットの設定情報を指定します。この設定には、シークレット ARN、およびシークレットへのアクセスを提供する IAM ロールの ARN が含まれます。詳細については、「管理するシークレットの使用」を参照してください。

注記

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

型: CustomSecretConfig オブジェクト

必須: いいえ

KerberosKeytab

定義された Kerberos プリンシパルと暗号化キー間のマッピングを含む Kerberos キーテーブル (キータブ)。ファイルのアドレスを指定して、ファイルからキータブをロードできます。

注記

KERBEROSAuthenticationType に指定した場合、このパラメータが必要です。

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

長さの制約: 最大長は 65,536 です。

必須: いいえ

KerberosKrb5Conf

Kerberos 構成情報を含む krb5.conf ファイル。ファイルのアドレスを指定して、krb5.conf ファイルをロードできます。 AWS CLIを使用している場合は、base64 エンコードが実行されます。それ以外の場合は、base64 でエンコードされたテキストを指定します。

注記

KERBEROSAuthenticationType に指定した場合、このパラメータが必要です。

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

長さの制約: 最大長は 131,072 です。

必須: いいえ

KerberosPrincipal

HDFS クラスター上のファイルとフォルダーへのアクセス権を持つ Kerberos プリンシパル。

注記

KERBEROSAuthenticationType に指定した場合、このパラメータが必要です。

タイプ: 文字列

長さの制約: 最小長は 1 です。最大長は 256 です。

パターン: ^.+$

必須: いいえ

KmsKeyProviderUri

HDFS クラスターのキー管理サーバー (KMS) の URI。

タイプ: 文字列

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

パターン: ^kms:\/\/http[s]?@(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9]))*:[0-9]{1,5}\/kms$

必須: いいえ

NameNodes

HDFS 名前空間を管理する NameNode。NameNode は、ファイルやディレクトリのオープン、クローズ、名前の変更などの操作を実行します。NameNode には、データのブロックを DataNode にマップするための情報が含まれています。NameNode は 1 つのみを使用できます。

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

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

必須: はい

QopConfiguration

保護の品質 (QOP) 設定では、Hadoop 分散ファイルシステム (HDFS) クラスターで構成されたリモートプロシージャコール (RPC) とデータ転送保護の設定を指定します。QopConfiguration が指定されなかった場合、RpcProtection および DataTransferProtectionPRIVACY をデフォルトにします。RpcProtection または DataTransferProtection を設定した場合、もう一方のパラメータは同じ値を想定します。

タイプ: QopConfiguration オブジェクト

必須: いいえ

ReplicationFactor

HDFS クラスターへの書き込み時にデータをレプリケートする DataNode の数。デフォルトでは、データは 3 つの DataNode にレプリケートされます。

タイプ: 整数

有効範囲: 最小値 は 1 です。最大値は 512 です。

必須: いいえ

SimpleUser

ホストオペレーティングシステム上のクライアントを識別するために使用されるユーザー名。

注記

SIMPLEAuthenticationType に指定した場合、このパラメータが必要です。

タイプ: 文字列

長さの制約: 最小長は 1 です。最大長は 256 です。

パターン: ^[_.A-Za-z0-9][-_.A-Za-z0-9]*$

必須: いいえ

Subdirectory

HDFS クラスター内のサブディレクトリ。このサブディレクトリは、HDFS クラスターからデータを読み取り、または HDFS クラスターにデータを書き込むために使用されます。サブディレクトリが指定されていない場合、デフォルトの / になります。

タイプ: 文字列

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

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

必須: いいえ

Tags

場所に追加するタグを表すキーと値のペア。値は空の文字列とすることができます。タグを使用してリソースに名前を付けることをお勧めします。

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

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

必須: いいえ

レスポンスの構文

{ "LocationArn": "string" }

レスポンス要素

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

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

LocationArn

作成されたソース HDFS クラスターの場所の ARN。

タイプ: 文字列

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

パターン: ^arn:(aws|aws-cn|aws-us-gov|aws-eusc|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 SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。