CreateLocationEfs - AWS DataSync
請求語法請求參數回應語法回應元素錯誤範例另請參閱

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

CreateLocationEfs

建立AWS DataSync可以存取 Transport 的 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

指定DataSync用於存取 Amazon EFS 檔案系統的存取點 Amazon Resource Name (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

指定DataSync用於存取 Amazon EFS 檔案系統的子網路和安全群組。

類型：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) 角色。

類型：字串

長度限制：長度上限為 2048。

模式：^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$

必要：否

InTransitEncryption

指定當資料複製DataSync到 Amazon EFS 檔案系統或從 Amazon EFS 檔案系統複製資料時，是否要使用 Transport Layer Security (TLS) 1.2 加密。

如果您使用 AccessPointArn 指定存取點或使用 FileSystemAccessRoleArn 指定 IAM 角色，則必須將此參數設定為 TLS1_2。

類型：字串

有效值: NONE | TLS1_2

必要：否

Subdirectory

為 Amazon EFS 檔案系統指定掛載路徑。這是DataSync讀取或寫入資料的位置 (取決於這是來源還是目的地位置)。預設DataSync會使用根目錄，但您也可以包含子目錄。

注意

您必須使用正斜線指定值 (例如，/path/to/folder)。

類型：字串

長度限制：長度上限為 4096。

模式：^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$

必要：否

Tags

指定代表您要新增至資源之標籤的鍵/值對。此數值可以是空字串。此值可協助您管理、篩選和搜尋資源。建議您為位置建立名稱標籤。

類型：TagListEntry 物件陣列

陣列成員：項目數下限為 0。項目數上限為 50。

必要：否

回應語法

{
   "LocationArn": "string"
}

回應元素

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

LocationArn

您建立的 Amazon EFS 文件系統位置的 Amazon Resource Name (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 檔案系統建立位置。在這種情況下，您可能必須在請求InTransitEncryption中指定AccessPointArnFileSystemAccessRoleArn、和的值。

{
    "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 文件系統的位置。

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

另請參閱

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：