AWS::DynamoDB::GlobalTable - AWS CloudFormation

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

AWS::DynamoDB::GlobalTable

AWS::DynamoDB::GlobalTable 資源可以讓您建立並管理 2019.11.21 版本的全域資料表。此資源無法用於建立或管理 2017.11.29 版本的全域資料表。如需詳細資訊,請參閱全域資料表

重要

您無法透過在模板中變更資源類型,將類型為 AWS::DynamoDB::Table 的資源轉換為類型為 AWS::DynamoDB::GlobalTable 的資源。這種做法可能會導致您的 DynamoDB 資料表被刪除。

您可以改為使用 GlobalTable 資源在單一區域中建立新表格。這會按照單一區域資料表計費方式收費。如果您稍後更新堆疊來新增其他區域,則將根據全域資料表的定價付費。

使用 DynamoDB 全域資料表時,您應該注意下列行為。

  • 在您計劃擁有全域資料表複本的所有區域中,執行堆疊操作的 IAM 主體必須具有下列許可。IAM 主體的許可不應包含基於 IP 來源地址的限制。某些全域資料表操作 (例如,新增複本) 是非同步操作,且需要 IAM 主體在操作完成前都有效。在完成堆疊更新之 CloudFormation 前,您不應刪除主體 (使用者或 IAM 角色)。

    • dynamodb:CreateTable

    • dynamodb:UpdateTable

    • dynamodb:DeleteTable

    • dynamodb:DescribeContinuousBackups

    • dynamodb:DescribeContributorInsights

    • dynamodb:DescribeTable

    • dynamodb:DescribeTableReplicaAutoScaling

    • dynamodb:DescribeTimeToLive

    • dynamodb:ListTables

    • dynamodb:UpdateTimeToLive

    • dynamodb:UpdateContributorInsights

    • dynamodb:UpdateContinuousBackups

    • dynamodb:ListTagsOfResource

    • dynamodb:TagResource

    • dynamodb:UntagResource

    • dynamodb:BatchWriteItem

    • dynamodb:CreateTableReplica

    • dynamodb:DeleteItem

    • dynamodb:DeleteTableReplica

    • dynamodb:DisableKinesisStreamingDestination

    • dynamodb:EnableKinesisStreamingDestination

    • dynamodb:GetItem

    • dynamodb:PutItem

    • dynamodb:Query

    • dynamodb:Scan

    • dynamodb:UpdateItem

    • dynamodb:DescribeTableReplicaAutoScaling

    • dynamodb:UpdateTableReplicaAutoScaling

    • iam:CreateServiceLinkedRole

    • kms:CreateGrant

    • kms:DescribeKey

    • application-autoscaling:DeleteScalingPolicy

    • application-autoscaling:DeleteScheduledAction

    • application-autoscaling:DeregisterScalableTarget

    • application-autoscaling:DescribeScalingPolicies

    • application-autoscaling:DescribeScalableTargets

    • application-autoscaling:PutScalingPolicy

    • application-autoscaling:PutScheduledAction

    • application-autoscaling:RegisterScalableTarget

  • 使用佈建的計費模式時, CloudFormation 會在每個複本上建立 auto 擴展政策,以控制其寫入容量。您必須使用WriteProvisionedThroughputSettings內容來設定此原則。 CloudFormation將確保所有複本具有相同的寫入容量 auto 擴展屬性。您無法直接指定全域資料表的寫入容量值。

  • 如果資料表使用佈建的容量,您必須直接在 AWS::DynamoDB::GlobalTable 資源中設定自動擴展。您不應透過 API 或者透過 AWS::ApplicationAutoScaling::ScalableTargetAWS::ApplicationAutoScaling::ScalingPolicy 在任何資料表複本或全域次要索引上設定其他自動擴展政策。這種做法可能會導致意外行為,因此不受支援。

  • 在中 AWS CloudFormation,無論複本數目為何,每個全域表都由單一區域中的單一堆疊控制。當您部署範本時, CloudFormation 會建立/更新所有複本,做為單一堆疊作業的一部分。您不應該在多個區域中部署相同的 AWS::DynamoDB::GlobalTable 資源。這種做法會導致錯誤,因此不受支援。如果您在多個區域中部署應用程式範本,則可以使用條件僅在單一區域中建立資源。您也可以選擇在與應用程式分開的堆疊中定義 AWS::DynamoDB::GlobalTable 資源,並確保它僅部署到單一區域。

語法

若要在 AWS CloudFormation 範本中宣告此實體,請使用下列語法:

屬性

AttributeDefinitions

屬性清單,其中的屬性會說明全域資料表與索引的索引鍵結構描述。

必要:是

類型:陣列 AttributeDefinition

下限1

更新要求不中斷

BillingMode

指定如何向您收取讀取與寫入輸送量的費用,以及您如何管理容量。有效的 值如下:

  • PAY_PER_REQUEST

  • PROVISIONED

全域資料表中的所有複本都會採用相同的計費模式。如果您使用 PROVISIONED 計費模式,則必須透過 WriteProvisionedThroughputSettings 屬性提供自動擴展組態。此屬性的預設值為 PROVISIONED

必要:否

類型:字串

允許值PROVISIONED | PAY_PER_REQUEST

更新要求不中斷

GlobalSecondaryIndexes

全域資料表上待建立的全域次要索引。您最多可以建立 20 個全域輔助索引。全域資料表中的每個複本都會採用相同的全域次要索引設定。在單一堆疊操作中,您只能建立或刪除一個全域次要索引。

由於回填索引可能需要很長時間,因此 CloudFormation 不會等待索引變為作用中狀態。如果堆疊作業回復, CloudFormation 可能不會刪除已新增的索引。在這種情況下,您需要手動刪除索引。

必要:否

類型GlobalSecondary索引數

更新要求不中斷

KeySchema

可藉由此屬性來指定資料表所含的主要索引鍵屬性。AttributeDefinitions 屬性中也必須定義 KeySchema 屬性中的屬性。

必要:是

類型陣列 KeySchema

下限1

上限2

更新要求替換

LocalSecondaryIndexes

資料表上待建立的本機次要索引;最多可以建立 5 個本機次要索引。每個索引的範圍不得超過指定的雜湊索引鍵值,而每個雜湊索引鍵的大小最高可達 10 GB。全域資料表中的每個複本都會採用相同的本機次要索引設定。

必要:否

類型LocalSecondary索引數

更新要求替換

Replicas

指定全域資料表的複本清單。清單必須包含至少一個元素,即定義全域資料表之堆疊所在的區域。例如,如果您在已部署至 us-east-1 的堆疊中定義資料表,則必須在 Replicas 中有一個帶有 us-east-1 區域的項目。您無法移除堆疊區域中的複本。

重要

如果是空白資料表,新增複本可能需要幾分鐘的時間;如果是大型資料表,則最多可能需要數小時。如果要新增或移除複本,建議您提交僅包含該變更的 UpdateStack 操作。

如果要在更新期間新增或刪除複本,建議您不要更新任何其他資源。若堆疊更新失敗並在新增新新複本時復原,您可能需要手動刪除複本。

您可以視需要建立包含任意數量複本的新全域資料表。您可以在資料表建立後新增或移除複本,但每次更新只能新增或移除單一複本。

必要:是

類型:陣列 ReplicaSpecification

下限1

更新要求不中斷

SSESpecification

指定此屬性來啟用伺服器端加密。這些設定將套用至所有複本。若計劃使用客戶受管 KMS 金鑰,則必須使用 ReplicaSpecification.ReplicaSSESpecification 屬性提供每個複本的金鑰。

必要:否

類型SSESpecification

更新要求不中斷

StreamSpecification

在全域資料表上指定串流設定。如果全域資料表包含多個複本,您必須提供此屬性的值。如果全域資料表只有一個複本,您只能變更串流設定。

必要:否

類型:StreamSpecification

更新要求不中斷

TableName

全域資料表的名稱。如果您不指定名稱, AWS CloudFormation 將產生唯一 ID,並將此 ID 用作資料表名稱。如需詳細資訊,請參閱名稱類型

重要

若指定名稱,則無法執行需要替換該資源的更新。可執行不需中斷或僅需部分中斷的更新作業。若一定要替換此資源,請指定一個新名稱。

必要:否

類型:字串

模式[a-zA-Z0-9_.-]+

下限3

上限255

更新要求替換

TimeToLiveSpecification

指定資料表的存留時間 (TTL) 設定。此設定將套用至所有複本。

必要:否

類型:TimeToLiveSpecification

更新要求不中斷

WriteOnDemandThroughputSettings

設定全域資料表或全域次要索引的寫入要求設定。如果將設定為,則必須指定此設BillingModePAY_PER_REQUEST

必要:否

類型WriteOnDemandThroughput設定

更新要求不中斷

WriteProvisionedThroughputSettings

為寫入容量指定自動擴展政策。此政策將套用至所有複本。如果 BillingMode 設定為 PROVISIONED,則必須指定此設定。

必要:否

類型:WriteProvisionedThroughputSettings

更新要求不中斷

傳回值

Ref

當您將此資源的邏輯 ID 傳遞至內部 Ref 函數時,Ref 便會傳回資料表名稱。

如需使用 Ref 函數的詳細資訊,請參閱 Ref

Fn:: GetAtt

Fn::GetAtt 內部函數會傳回此類型之指定屬性的值。以下為可用屬性及傳回值的範例。

如需有關使用 Fn::GetAtt 內部函數的詳細資訊,請參閱 Fn::GetAtt

Arn

DynamoDB 資料表的 Amazon Resource Name (ARN),例如 arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable。傳回的 ARN 是部署堆疊所在區域中的複本 ARN。

StreamArn

DynamoDB 串流的 ARN,例如 arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000。傳回的 StreamArn 是部署堆疊所在區域中的複本 ARN。

注意

您必須指定 StreamSpecification 屬性,才能使用此屬性。

TableId

資料表的唯一識別碼,例如 a123b456-01ab-23cd-123a-111222aaabbb。傳回的 TableId 是部署堆疊所在區域中的複本 ARN。