翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
CreateLocationFsxWindows
Amazon FSx for Windows File Server ファイルシステムの転送場所を作成します。この場所をデータ転送のソースまたは送信先として AWS DataSync 使用できます。
始める前に、必ず DataSync がどのように FSx for Windows File Server ファイルシステムにアクセスするのかを理解してください。
リクエストの構文
{
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"Domain": "string",
"FsxFilesystemArn": "string",
"Password": "string",
"SecurityGroupArns": [ "string" ],
"Subdirectory": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"User": "string"
}リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
- CmkSecretConfig
-
DataSync が管理するシークレットの設定情報を指定します。これには、DataSync がカスタマーマネージドで特定の FSx Windows ストレージの場所にアクセスするために使用するパスワードが含まれます AWS KMS key。
このパラメータを
CreateLocationFsxWindowsリクエストの一部として含める場合は、KMS キー ARN のみを指定します。DataSync は、この KMS キーを にPassword指定した とともに使用して、ロケーションアクセス認証情報を保存する DataSync マネージドシークレットを作成します。DataSync に、指定した KMS キーへのアクセス許可があることを確認します。詳細については、「カスタムで暗号化されたサービスマネージドシークレットの使用 AWS KMS key」を参照してください。
注記
CmkSecretConfig(Passwordあり) またはCustomSecretConfig(Passwordなし) を使用して、CreateLocationFsxWindowsリクエストの認証情報を指定できます。同じリクエストに対して両方のパラメータを指定しないでください。型: CmkSecretConfig オブジェクト
必須: いいえ
- CustomSecretConfig
-
FSx for Windows File Server ストレージの場所のパスワードが Secrets Manager のプレーンテキストで保存される、カスタマー管理の Secrets Manager シークレットの設定情報を指定します。この設定には、シークレット ARN、およびシークレットへのアクセスを提供する IAM ロールの ARN が含まれます。詳細については、「管理するシークレットの使用」を参照してください。
注記
CmkSecretConfig(Passwordあり) またはCustomSecretConfig(Passwordなし) を使用して、CreateLocationFsxWindowsリクエストの認証情報を指定できます。同じリクエストに対して両方のパラメータを指定しないでください。型: CustomSecretConfig オブジェクト
必須: いいえ
- Domain
-
FSx for Windows ファイルサーバーシステムが属する Windows ドメインの名前を指定します。
環境内に複数の Active Directory ドメインがある場合、このパラメータを設定することで、DataSync が適切なファイルシステムに接続できるようになります。
タイプ: 文字列
長さの制約: 最大長は 253 です。
パターン:
^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$必須: いいえ
- FsxFilesystemArn
-
FSx for Windows File Server ファイルシステムの Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン:
^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$必須: はい
- Password
-
FSx for Windows File Server ファイルシステム内のファイル、フォルダ、ファイルメタデータをマウントしてアクセスできるアクセス許可を持つユーザーのパスワードを指定します。
タイプ: 文字列
長さの制約: 最大長は 104 です。
パターン:
^.{0,104}$必須: いいえ
- SecurityGroupArns
-
ファイルシステムの優先サブネットへのアクセスを提供する Amazon EC2 セキュリティグループの ARN を指定します。
指定したセキュリティグループは、ファイルシステムのセキュリティグループと通信できる必要があります。セキュリティグループの設定については、「Amazon FSx for Windows File Server ユーザーガイド」を参照してください。
注記
内部からの接続を許可しないセキュリティグループを選択した場合は、次のいずれかの操作を行います。
-
セキュリティグループをセキュリティグループ内で通信できるように設定します。
-
マウントターゲットのセキュリティグループと通信できる、別のセキュリティグループを選択します。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大数は 5 項目です。
長さの制約: 最大長は 128 です。
パターン:
^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$必須: はい
-
- Subdirectory
-
スラッシュを使用して、ファイルシステムのマウントパスを指定します。これは、DataSync がデータを読み書きする場所です (送信元あるいは送信先の場所によって異なります)。
タイプ: 文字列
長さの制約: 最大長は 4,096 です。
パターン:
^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$必須: いいえ
- Tags
-
AWS リソースの分類、フィルタリング、および検索に役立つラベルを指定します。少なくても場所の名前タグを作成することを推奨します。
タイプ: TagListEntry オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
- User
-
FSx for Windows File Server ファイルシステム内のファイル、フォルダ、ファイルメタデータをマウントしてアクセスできるアクセス許可を持つユーザーを指定します。
転送に適したアクセスレベルのユーザーを選択する方法については、FSx for Windows File Server の場所に「required permissions」を参照してください。
タイプ: 文字列
長さの制約: 最大長は 104 です。
パターン:
^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$必須: はい
レスポンスの構文
{
"LocationArn": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- LocationArn
-
作成した FSx for Windows File Server ファイルシステムの場所の 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 を使用する方法の詳細については、以下を参照してください。
