CreateLocationEfs - AWS DataSync
リクエストの構文リクエストパラメータレスポンスの構文レスポンス要素エラー例以下の資料も参照してください。

2023 年 12 月 7 日より、バージョン 1 DataSync のエージェントは廃止されます。 DataSync コンソールの [エージェント] ページをチェックして、影響を受けるエージェントがいないか確認してください。その場合は、データ転送やストレージ検出の中断を避けるため、その前にそれらのエージェントを交換してください。さらにサポートが必要な場合は、お問い合わせくださいAWS Support。

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

CreateLocationEfs

AWS DataSync転送のためにアクセスできる Amazon EFS ファイルシステムのエンドポイントを作成します。詳細については、「Amazon EFS のロケーションの作成」を参照してください。

リクエストの構文

{
   "AccessPointArn": "string",
   "Ec2Config": { 
      "SecurityGroupArns": [ "string" ],
      "SubnetArn": "string"
   },
   "EfsFilesystemArn": "string",
   "FileSystemAccessRoleArn": "string",
   "InTransitEncryption": "string",
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

リクエストパラメータ

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

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

AccessPointArn

Amazon EFS DataSync ファイルシステムへのアクセスに使用するアクセスポイントの Amazon リソースネーム (ARN) を指定します。

型: 文字列

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

パターン: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$

必須: いいえ

Ec2Config

Amazon EFS DataSync ファイルシステムへのアクセスに使用するサブネットとセキュリティグループを指定します。

型: Ec2Config オブジェクト

必須: はい

EfsFilesystemArn

Amazon EFS ファイルシステムの ARN を指定します。

型: 文字列

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

パターン: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]*:[0-9]{12}:file-system/fs-.*$

必須: はい

FileSystemAccessRoleArn

Amazon EFS DataSync ファイルシステムをマウントするときに引き受ける AWS Identity and Access Management (IAM) ロールを指定します。

型: 文字列

長さの制限: 最大長は 2,048 です。

パターン: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$

必須: いいえ

InTransitEncryption

Amazon EFS DataSync ファイルシステムとの間でデータをコピーするときに、トランスポート層セキュリティ (TLS) 1.2 暗号化を使用するかどうかを指定します。

AccessPointArn または FileSystemAccessRoleArn を使用した IAM ロールを使用してアクセスポイントを指定する場合、このパラメータを TLS1_2 に設定する必要があります。

タイプ: 文字列

有効な値: NONE | TLS1_2

必須: いいえ

Subdirectory

Amazon EFS ファイルシステムのマウントパスを指定します。 DataSync ここでデータを読み取ったり書き込んだりします (送信元か宛先かによって異なります)。 DataSync デフォルトではルートディレクトリを使用しますが、サブディレクトリを含めることもできます。

注記

スラッシュ (/path/to/folder など) を含む値を指定する必要があります。

型: 文字列

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

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

必須: いいえ

Tags

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

型: TagListEntry オブジェクトの配列

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

必須: いいえ

レスポンスの構文

{
   "LocationArn": "string"
}

レスポンス要素

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

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

LocationArn

作成した Amazon EFS ファイルシステムロケーションのアマゾンリソースネーム (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

例

リクエスト例

次の例では、Amazon EFS ファイルシステムの場所を作成します。

{
    "Ec2Config": {
        "SubnetArn": "arn:aws:ec2:us-east-2:11122233344:subnet/subnet-1234567890abcdef1",
        "SecurityGroupArns": [
            "arn:aws:ec2:us-east-2:11122233344:security-group/sg-1234567890abcdef2"
        ]
    },
    "EfsFilesystemArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:file-system/fs-021345abcdef6789",
    "Subdirectory": "/mount/path",
    "Tags": [{
        "Key": "Name",
        "Value": "ElasticFileSystem-1"
    }]
}

サンプルリクエスト:制限付き Amazon EFS ファイルシステムの場所の作成

次の例では、アクセスが制限された Amazon EFS ファイルシステムの場所を作成します。このようなシナリオでは、、AccessPointArnFileSystemAccessRoleArn、InTransitEncryptionの値をリクエストで指定しなければならない場合があります。

{
    "AccessPointArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:access-point/fsap-1234567890abcdef0",
    "Ec2Config": {
        "SubnetArn": "arn:aws:ec2:us-east-2:111222333444:subnet/subnet-1234567890abcdef1",
        "SecurityGroupArns": [
            "arn:aws:ec2:us-east-2:111222333444:security-group/sg-1234567890abcdef2"
        ]
    },
    "FileSystemAccessRoleArn": "arn:aws:iam::111222333444:role/AwsDataSyncFullAccessNew",
    "InTransitEncryption": "TLS1_2",
    "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-abcdef01234567890",
    "LocationUri": "efs://us-east-2.fs-021345abcdef6789/",
    "Subdirectory": "/mount/path",
    "Tags": [{
        "Key": "Name",
        "Value": "ElasticFileSystem-1"
    }]
}

レスポンス例

レスポンスは Amazon EFS ファイルシステムのロケーション ARN を返します。

{
  "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-12abcdef012345678"
}

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

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