CreateLocationS3 - AWS DataSync

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

CreateLocationS3

建立 Amazon S3 儲存貯體的端點。

如需詳細資訊,請參閱「」建立 Amazon S3 位置中的 AWS DataSync使用者指南

請求語法

{ "AgentArns": [ "string" ], "S3BucketArn": "string", "S3Config": { "BucketAccessRoleArn": "string" }, "S3StorageClass": "string", "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

請求參數

如需所有動作通用參數的相關資訊,請參閱一般參數

請求接受採用 JSON 格式的下列資料。

AgentArns

如果您 DataSync 使用AWS前哨站,指定部署在您的前哨站上的 DataSync 代理程式的亞馬遜資源名稱 (ARN)。如需有關啟動 DataSync 代理程式的詳細資訊AWS前哨,請參閱將您的 DataSync 代理程式部署到AWS Outposts

類型:字串陣列

陣列成員:項目數下限為 1。項目數上限為 4。

長度限制:長度上限為 128。

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

必要:否

S3BucketArn

Amazon S3 儲存貯體的 ARN。如果存儲桶位於AWS前哨站這一定是一個接入點 ARN

類型:字串

長度限制:長度上限為 156。

模式:^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\-0-9]*:[0-9]*:.*$

必要:是

S3Config

的 Amazon Resource Name (ARN)AWS Identity and Access Management(IAM) 角色,用於存取 Amazon S3 儲存貯體。

如需使用此類角色的詳細資訊,請參閱為 Amazon S3 創建位置中的 AWS DataSync使用者指南

類型:S3Config 物件

必要:是

S3StorageClass

將此位置用作任務目的地時,您想要將檔案存放在其中的 Amazon S3 儲存方案。對於儲存貯體AWS 區域,儲存方案預設為標準。對於儲存貯體AWS Outposts,儲存方案預設為AWSS3 Outposts 站。

如需 S3 儲存方案的詳細資訊,請參閱 Amazon S3 儲存方案。有些儲存方案的行為可能會影響 S3 儲存成本。如需詳細資訊,請參閱在 DataSync 中使用 S3 儲存類別時的考量

類型:字串

有效值: STANDARD | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS

必要:否

Subdirectory

Amazon S3 儲存貯體中的子目錄。Amazon S3 中的此子目錄用於從 S3 來源位置讀取資料或寫入資料至 S3 目的地。

類型:字串

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

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

必要:否

Tags

代表您要新增至位置之標籤的鍵值對。此數值可以是空字串。建議您使用標籤來命名資源。

類型:陣列TagListEntry對象

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

必要:否

回應語法

{ "LocationArn": "string" }

回應元素

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

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

LocationArn

建立的來源 Amazon S3 儲存貯體位置的 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}$

Errors

如需所有動作常見的錯誤相關資訊,請參閱常見錯誤

InternalException

當發生錯誤時,就會擲出此例外狀況AWS DataSync服務。

HTTP 狀態碼:500

InvalidRequestException

當客戶端提交格式錯誤的請求時,就會擲出此例外狀況。

HTTP 狀態碼:400

Examples

步驟 1. 允許擔任寫入至儲存貯體所需的 IAM 角色

以下範例說明授與必要許可的最簡單政策。AWS DataSync存取目的地 Amazon S3 儲存貯體,然後是 IAM 角色,create-location-s3-iam-role政策已連接。

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "datasync.amazonaws.com" }, "Action": "sts:AssumeRole" } ] }
"Role": { "Path": "/", "RoleName": "MyBucketAccessRole", "RoleId": "role-id", "Arn": "arn:aws:iam::account-id:role/MyBucketAccessRole", "CreateDate": "2018-07-27T02:49:23.117Z", "AssumeRolePolicyDocument": { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "datasync.amazonaws.com" }, "Action": "sts:AssumeRole" } ] } } }

步驟 2. 允許建立的 IAM 角色寫入至儲存貯體

您可以將擁有足夠許可存取儲存貯體的政策連接至該角色。這種政策的一個例子是AWSDataSyncFullAccess受管政策。

如需詳細資訊,請參閱「」AWS 資料集全面存取您可以在 IAM 主控台中使用。

您不需要建立此政策。它由AWS,所以你需要做的 ARN 是在attach-role-policy命令。

IAM_POLICY_ARN='arn:aws:iam::aws:policy/AWSDataSyncFullAccess'

步驟 3. 建立 Amazon S3 儲存貯體的端點

以下範例建立 Amazon S3 儲存貯體的端點。

建立 S3 終端節點時,類似下列第二個範例的回應會傳回新 Amazon S3 位置的 Amazon 資源名稱 (ARN)。

請求範例

{ "S3BucketArn": "arn:aws:s3:::MyBucket", "S3Config": { "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/MyBucketAccessRole", }, "S3StorageClass": "STANDARD", "Subdirectory": "/MyFolder", "Tags": [ { "Key": "Name", "Value": "s3Bucket-1" } ] }

回應範例

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

另請參閱

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