翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # CreateLocationSmb サーバーメッセージブロック (SMB) ファイルサーバーの転送*場所*を作成します。 AWS DataSync は、この場所をデータ転送のソースまたは送信先として使用できます。 始める前に、必ず DataSync がどのように SMB ファイルサーバーにアクセスするかを理解してください。詳細については、「[Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)」を参照してください。 ## リクエストの構文 ``` { "AgentArns": [ "string" ], "AuthenticationType": "string", "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "DnsIpAddresses": [ "string" ], "Domain": "string", "KerberosKeytab": blob, "KerberosKrb5Conf": blob, "KerberosPrincipal": "string", "MountOptions": { "Version": "string" }, "Password": "string", "ServerHostname": "string", "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "User": "string" } ``` ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 リクエストは以下のデータを JSON 形式で受け入れます。 ** [AgentArns](#API_CreateLocationSmb_RequestSyntax) ** SMB ファイルサーバーに接続可能な DataSync エージェント (1 つまたは複数) を指定します。エージェントは、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](#API_CreateLocationSmb_RequestSyntax) ** DataSync が SMB ファイルサーバーへの接続に使用する認証プロトコルを指定します。DataSync は `NTLM` (デフォルト) と `KERBEROS` 認証をサポートしています。 詳細については、「[Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)」を参照してください。 型: 文字列 有効な値：`NTLM | KERBEROS` 必須：いいえ ** [CmkSecretConfig](#API_CreateLocationSmb_RequestSyntax) ** DataSync が管理するシークレットの設定情報を指定します`KerberosKeytab`。DataSync がカスタマー管理の特定の SMB ストレージの場所にアクセスするために使用する `Password`または `NTLM` (デフォルト) および`KERBEROS`認証タイプのいずれかです AWS KMS key。 このパラメータを`CreateLocationSmbRequest`リクエストの一部として含める場合は、KMS キー ARN のみを指定します。DataSync は、この KMS キーを `Password`または `KerberosKeytab` のいずれかとともに使用して、ロケーションアクセス認証情報を保存する DataSync マネージドシークレットを作成します。 DataSync に、指定した KMS キーへのアクセス許可があることを確認します。詳細については、[「カスタムで暗号化されたサービスマネージドシークレットの使用 AWS KMS key](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key)」を参照してください。 ( `Password`または のいずれか`CmkSecretConfig`を使用`KerberosKeytab`) または `CustomSecretConfig` ( `Password`および なし`KerberosKeytab`) を使用して、`CreateLocationSmbRequest`リクエストの認証情報を指定できます。同じリクエストに パラメータ`CmkSecretConfig`と `CustomSecretConfig`パラメータの両方を指定しないでください。 型: [CmkSecretConfig](API_CmkSecretConfig.md) オブジェクト 必須: いいえ ** [CustomSecretConfig](#API_CreateLocationSmb_RequestSyntax) ** SMB ストレージの場所の認証情報が Secrets Manager にプレーンテキスト ( の場合`Password`) またはバイナリ ( の場合) として保存される、カスタマー管理の Secrets Manager シークレットの設定情報を指定します`KerberosKeytab`。この設定には、シークレット ARN、およびシークレットへのアクセスを提供する IAM ロールの ARN が含まれます。詳細については、[「管理するシークレットの使用](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key)」を参照してください。 `CmkSecretConfig` (`SasConfiguration` あり) または `CustomSecretConfig` (`SasConfiguration` なし) を使用して、`CreateLocationSmbRequest` リクエストの認証情報を指定できます。同じリクエストに対して両方のパラメータを指定しないでください。 型: [CustomSecretConfig](API_CustomSecretConfig.md) オブジェクト 必須: いいえ ** [DnsIpAddresses](#API_CreateLocationSmb_RequestSyntax) ** SMB ファイルサーバーが属する DNS サーバーの IPv4 または IPv6 アドレスを指定します。このパラメータは、`AuthenticationType` が `KERBEROS` に設定されている場合にのみ適用されます。 環境内に複数のドメインがある場合、このパラメータを構成することで、DataSync が適切な SMB ファイルサーバーに接続できるようになります。 型: 文字列の配列 配列メンバー: 最大数は 2 項目です。 長さの制限: 最小長は 7 です。最大長は 39 です。 パターン: `\A((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))\z` 必須: いいえ ** [Domain](#API_CreateLocationSmb_RequestSyntax) ** SMB ファイルサーバーが属する Windows ドメイン名を指定します。このパラメータは、`AuthenticationType` が `NTLM` に設定されている場合にのみ適用されます。 環境内に複数のドメインがある場合、このパラメータを構成することで、DataSync が適切なファイルサーバーに接続できるようになります。 タイプ: 文字列 長さの制約: 最大長は 253 です。 パターン: `^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$` 必須: いいえ ** [KerberosKeytab](#API_CreateLocationSmb_RequestSyntax) ** Kerberos キーテーブル (keytab) ファイルを指定します。これには、Kerberos プリンシパルと暗号化キー間のマッピングが含まれます。 タスク実行エラーを回避するには、キータブファイルの作成に使用する Kerberos プリンシパルが、`KerberosPrincipal` に指定した内容と正確に一致していることを確認します。 タイプ: Base64 でエンコードされたバイナリデータオブジェクト 長さの制約: 最大長は 65,536 です。 必須: いいえ ** [KerberosKrb5Conf](#API_CreateLocationSmb_RequestSyntax) ** Kerberos 領域設定を定義する Kerberos 設定ファイル (`krb5.conf`) を指定します。 ファイルは base64 でエンコードされている必要があります。を使用している場合は AWS CLI、エンコードが自動的に行われます。 タイプ: Base64 でエンコードされたバイナリデータオブジェクト 長さの制約: 最大長は 131,072 です。 必須: いいえ ** [KerberosPrincipal](#API_CreateLocationSmb_RequestSyntax) ** Kerberos プリンシパルを指定します。これは、SMB ファイルサーバーのファイル、フォルダ、ファイルメタデータにアクセスする権限を持つ Kerberos 領域内の ID です。 Kerberos プリンシパルは `HOST/kerberosuser@MYDOMAIN.ORG` のようになります。 プリンシパル名では大文字と小文字が区別されます。このパラメータに指定したプリンシパルが、キータブファイルの作成に使用するプリンシパルと完全に一致しない場合、DataSync タスク実行は失敗します。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 256 です。 パターン: `^.+$` 必須: いいえ ** [MountOptions](#API_CreateLocationSmb_RequestSyntax) ** DataSync が SMB ファイルサーバーにアクセスするために使用する SMB プロトコルのバージョンを指定します。 タイプ: [SmbMountOptions](API_SmbMountOptions.md) オブジェクト 必須: いいえ ** [Password](#API_CreateLocationSmb_RequestSyntax) ** SMB ファイルサーバーをマウントでき、転送するファイルとフォルダにアクセスできるユーザーのパスワード。このパラメータは、`AuthenticationType` が `NTLM` に設定されている場合にのみ適用されます。 タイプ: 文字列 長さの制約: 最大長は 104 です。 パターン: `^.{0,104}$` 必須: いいえ ** [ServerHostname](#API_CreateLocationSmb_RequestSyntax) ** DataSync エージェントが接続する SMB ファイルサーバーのドメイン名または IP アドレス (IPv4 または IPv6) を指定します。 Kerberos 認証を使用している場合は、ドメイン名を指定する必要があります。 タイプ: 文字列 長さの制約: 最大長は 255 です。 パターン: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$` 必須: はい ** [Subdirectory](#API_CreateLocationSmb_RequestSyntax) ** DataSync がデータを読み書記する SMB ファイルサーバーによってエクスポートされる共有の名前を指定します。共有パスにはサブディレクトリ (例: `/path/to/subdirectory`) を含めることができます。ネットワーク内の他の SMB クライアントもこのパスをマウントできることを確認してください。 サブディレクトリ内のすべてのデータをコピーするには、DataSync が SMB 共有をマウントし、そのすべてのデータにアクセスできる必要があります。詳細については、「[Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)」を参照してください。 タイプ: 文字列 長さの制約: 最大長は 4,096 です。 パターン: `^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$` 必須: はい ** [Tags](#API_CreateLocationSmb_RequestSyntax) ** AWS リソースの分類、フィルタリング、および検索に役立つラベルを指定します。少なくても場所の名前タグを作成することを推奨します。 タイプ: [TagListEntry](API_TagListEntry.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。 必須: いいえ ** [User](#API_CreateLocationSmb_RequestSyntax) ** SMB ファイルサーバー内のファイル、フォルダ、ファイルメタデータをマウントしてアクセスできるユーザーを指定します。このパラメータは、`AuthenticationType` が `NTLM` に設定されている場合にのみ適用されます。 転送に適したアクセスレベルを持つユーザーを選択する方法については、「[Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)」を参照してください。 タイプ: 文字列 長さの制約: 最大長は 104 です。 パターン: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$` 必須: いいえ ## レスポンスの構文 ``` { "LocationArn": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [LocationArn](#API_CreateLocationSmb_ResponseSyntax) ** 作成した SMB の場所の 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}$` ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** InternalException ** この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。 HTTP ステータスコード: 500 ** InvalidRequestException ** この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。 HTTP ステータスコード: 400 ## 例 ### リクエスト例 次の例では、SMB ファイルサーバーの場所を作成します。 ``` { "AgentArns":[ "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs", "arn:aws:datasync:us-east-2:111222333444:agent/agent-2345noo35nnee1123ovo3" ], "Domain":"AMAZON", "MountOptions":{ "Version":"SMB3" }, "Password":"string", "ServerHostname":"MyServer.amazon.com", "Subdirectory":"share", "Tags":[ { "Key":"department", "Value":"finance" } ], "User":"user-1" } ``` ### レスポンス例 レスポンスが、SMB ファイルサーバーの場所 ARN を返します。 ``` { "LocationArn": "arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49" } ``` ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationSmb) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationSmb) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationSmb) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationSmb) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationSmb) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationSmb) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationSmb) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationSmb) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationSmb) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationSmb)