Skip to content

Update Table

dynamodb_update_table R Documentation

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table

Description

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

You can only perform one of the following operations at once:

  • Modify the provisioned throughput settings of the table.

  • Remove a global secondary index from the table.

  • Create a new global secondary index on the table. After the index begins backfilling, you can use update_table to perform other operations.

update_table is an asynchronous operation; while it's executing, the table status changes from ACTIVE to UPDATING. While it's UPDATING, you can't issue another update_table request. When the table returns to the ACTIVE state, the update_table operation is complete.

Usage

dynamodb_update_table(AttributeDefinitions, TableName, BillingMode,
  ProvisionedThroughput, GlobalSecondaryIndexUpdates, StreamSpecification,
  SSESpecification, ReplicaUpdates, TableClass, DeletionProtectionEnabled,
  MultiRegionConsistency, OnDemandThroughput, WarmThroughput)

Arguments

AttributeDefinitions

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.
TableName

[required] The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
BillingMode

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

  • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
ProvisionedThroughput

The new provisioned throughput settings for the specified table or index.
GlobalSecondaryIndexUpdates

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

  • Create - add a new global secondary index to the table.

  • Update - modify the provisioned throughput settings of an existing global secondary index.

  • Delete - remove a global secondary index from the table.

You can create or delete only one global secondary index per update_table operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
StreamSpecification

Represents the DynamoDB Streams configuration for the table.

You receive a ValidationException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.
SSESpecification

The new server-side encryption settings for the specified table.
ReplicaUpdates

A list of replica update actions (create, delete, or update) for the table.

For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).
TableClass

The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
DeletionProtectionEnabled

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
MultiRegionConsistency

Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.

You can specify one of the following consistency modes:

  • EVENTUAL: Configures a new global table for multi-Region eventual consistency. This is the default consistency mode for global tables.

  • STRONG: Configures a new global table for multi-Region strong consistency (preview).

    Multi-Region strong consistency (MRSC) is a new DynamoDB global tables capability currently available in preview mode. For more information, see Global tables multi-Region strong consistency.

If you don't specify this parameter, the global table consistency mode defaults to EVENTUAL.
OnDemandThroughput

Updates the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
WarmThroughput

Represents the warm throughput (in read units per second and write units per second) for updating a table.

Value

A list with the following syntax:

list(
  TableDescription = list(
    AttributeDefinitions = list(
      list(
        AttributeName = "string",
        AttributeType = "S"|"N"|"B"
      )
    ),
    TableName = "string",
    KeySchema = list(
      list(
        AttributeName = "string",
        KeyType = "HASH"|"RANGE"
      )
    ),
    TableStatus = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"INACCESSIBLE_ENCRYPTION_CREDENTIALS"|"ARCHIVING"|"ARCHIVED",
    CreationDateTime = as.POSIXct(
      "2015-01-01"
    ),
    ProvisionedThroughput = list(
      LastIncreaseDateTime = as.POSIXct(
        "2015-01-01"
      ),
      LastDecreaseDateTime = as.POSIXct(
        "2015-01-01"
      ),
      NumberOfDecreasesToday = 123,
      ReadCapacityUnits = 123,
      WriteCapacityUnits = 123
    ),
    TableSizeBytes = 123,
    ItemCount = 123,
    TableArn = "string",
    TableId = "string",
    BillingModeSummary = list(
      BillingMode = "PROVISIONED"|"PAY_PER_REQUEST",
      LastUpdateToPayPerRequestDateTime = as.POSIXct(
        "2015-01-01"
      )
    ),
    LocalSecondaryIndexes = list(
      list(
        IndexName = "string",
        KeySchema = list(
          list(
            AttributeName = "string",
            KeyType = "HASH"|"RANGE"
          )
        ),
        Projection = list(
          ProjectionType = "ALL"|"KEYS_ONLY"|"INCLUDE",
          NonKeyAttributes = list(
            "string"
          )
        ),
        IndexSizeBytes = 123,
        ItemCount = 123,
        IndexArn = "string"
      )
    ),
    GlobalSecondaryIndexes = list(
      list(
        IndexName = "string",
        KeySchema = list(
          list(
            AttributeName = "string",
            KeyType = "HASH"|"RANGE"
          )
        ),
        Projection = list(
          ProjectionType = "ALL"|"KEYS_ONLY"|"INCLUDE",
          NonKeyAttributes = list(
            "string"
          )
        ),
        IndexStatus = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE",
        Backfilling = TRUE|FALSE,
        ProvisionedThroughput = list(
          LastIncreaseDateTime = as.POSIXct(
            "2015-01-01"
          ),
          LastDecreaseDateTime = as.POSIXct(
            "2015-01-01"
          ),
          NumberOfDecreasesToday = 123,
          ReadCapacityUnits = 123,
          WriteCapacityUnits = 123
        ),
        IndexSizeBytes = 123,
        ItemCount = 123,
        IndexArn = "string",
        OnDemandThroughput = list(
          MaxReadRequestUnits = 123,
          MaxWriteRequestUnits = 123
        ),
        WarmThroughput = list(
          ReadUnitsPerSecond = 123,
          WriteUnitsPerSecond = 123,
          Status = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"
        )
      )
    ),
    StreamSpecification = list(
      StreamEnabled = TRUE|FALSE,
      StreamViewType = "NEW_IMAGE"|"OLD_IMAGE"|"NEW_AND_OLD_IMAGES"|"KEYS_ONLY"
    ),
    LatestStreamLabel = "string",
    LatestStreamArn = "string",
    GlobalTableVersion = "string",
    Replicas = list(
      list(
        RegionName = "string",
        ReplicaStatus = "CREATING"|"CREATION_FAILED"|"UPDATING"|"DELETING"|"ACTIVE"|"REGION_DISABLED"|"INACCESSIBLE_ENCRYPTION_CREDENTIALS",
        ReplicaStatusDescription = "string",
        ReplicaStatusPercentProgress = "string",
        KMSMasterKeyId = "string",
        ProvisionedThroughputOverride = list(
          ReadCapacityUnits = 123
        ),
        OnDemandThroughputOverride = list(
          MaxReadRequestUnits = 123
        ),
        WarmThroughput = list(
          ReadUnitsPerSecond = 123,
          WriteUnitsPerSecond = 123,
          Status = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"INACCESSIBLE_ENCRYPTION_CREDENTIALS"|"ARCHIVING"|"ARCHIVED"
        ),
        GlobalSecondaryIndexes = list(
          list(
            IndexName = "string",
            ProvisionedThroughputOverride = list(
              ReadCapacityUnits = 123
            ),
            OnDemandThroughputOverride = list(
              MaxReadRequestUnits = 123
            ),
            WarmThroughput = list(
              ReadUnitsPerSecond = 123,
              WriteUnitsPerSecond = 123,
              Status = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"
            )
          )
        ),
        ReplicaInaccessibleDateTime = as.POSIXct(
          "2015-01-01"
        ),
        ReplicaTableClassSummary = list(
          TableClass = "STANDARD"|"STANDARD_INFREQUENT_ACCESS",
          LastUpdateDateTime = as.POSIXct(
            "2015-01-01"
          )
        )
      )
    ),
    RestoreSummary = list(
      SourceBackupArn = "string",
      SourceTableArn = "string",
      RestoreDateTime = as.POSIXct(
        "2015-01-01"
      ),
      RestoreInProgress = TRUE|FALSE
    ),
    SSEDescription = list(
      Status = "ENABLING"|"ENABLED"|"DISABLING"|"DISABLED"|"UPDATING",
      SSEType = "AES256"|"KMS",
      KMSMasterKeyArn = "string",
      InaccessibleEncryptionDateTime = as.POSIXct(
        "2015-01-01"
      )
    ),
    ArchivalSummary = list(
      ArchivalDateTime = as.POSIXct(
        "2015-01-01"
      ),
      ArchivalReason = "string",
      ArchivalBackupArn = "string"
    ),
    TableClassSummary = list(
      TableClass = "STANDARD"|"STANDARD_INFREQUENT_ACCESS",
      LastUpdateDateTime = as.POSIXct(
        "2015-01-01"
      )
    ),
    DeletionProtectionEnabled = TRUE|FALSE,
    OnDemandThroughput = list(
      MaxReadRequestUnits = 123,
      MaxWriteRequestUnits = 123
    ),
    WarmThroughput = list(
      ReadUnitsPerSecond = 123,
      WriteUnitsPerSecond = 123,
      Status = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"INACCESSIBLE_ENCRYPTION_CREDENTIALS"|"ARCHIVING"|"ARCHIVED"
    ),
    MultiRegionConsistency = "EVENTUAL"|"STRONG"
  )
)

Request syntax

svc$update_table(
  AttributeDefinitions = list(
    list(
      AttributeName = "string",
      AttributeType = "S"|"N"|"B"
    )
  ),
  TableName = "string",
  BillingMode = "PROVISIONED"|"PAY_PER_REQUEST",
  ProvisionedThroughput = list(
    ReadCapacityUnits = 123,
    WriteCapacityUnits = 123
  ),
  GlobalSecondaryIndexUpdates = list(
    list(
      Update = list(
        IndexName = "string",
        ProvisionedThroughput = list(
          ReadCapacityUnits = 123,
          WriteCapacityUnits = 123
        ),
        OnDemandThroughput = list(
          MaxReadRequestUnits = 123,
          MaxWriteRequestUnits = 123
        ),
        WarmThroughput = list(
          ReadUnitsPerSecond = 123,
          WriteUnitsPerSecond = 123
        )
      ),
      Create = list(
        IndexName = "string",
        KeySchema = list(
          list(
            AttributeName = "string",
            KeyType = "HASH"|"RANGE"
          )
        ),
        Projection = list(
          ProjectionType = "ALL"|"KEYS_ONLY"|"INCLUDE",
          NonKeyAttributes = list(
            "string"
          )
        ),
        ProvisionedThroughput = list(
          ReadCapacityUnits = 123,
          WriteCapacityUnits = 123
        ),
        OnDemandThroughput = list(
          MaxReadRequestUnits = 123,
          MaxWriteRequestUnits = 123
        ),
        WarmThroughput = list(
          ReadUnitsPerSecond = 123,
          WriteUnitsPerSecond = 123
        )
      ),
      Delete = list(
        IndexName = "string"
      )
    )
  ),
  StreamSpecification = list(
    StreamEnabled = TRUE|FALSE,
    StreamViewType = "NEW_IMAGE"|"OLD_IMAGE"|"NEW_AND_OLD_IMAGES"|"KEYS_ONLY"
  ),
  SSESpecification = list(
    Enabled = TRUE|FALSE,
    SSEType = "AES256"|"KMS",
    KMSMasterKeyId = "string"
  ),
  ReplicaUpdates = list(
    list(
      Create = list(
        RegionName = "string",
        KMSMasterKeyId = "string",
        ProvisionedThroughputOverride = list(
          ReadCapacityUnits = 123
        ),
        OnDemandThroughputOverride = list(
          MaxReadRequestUnits = 123
        ),
        GlobalSecondaryIndexes = list(
          list(
            IndexName = "string",
            ProvisionedThroughputOverride = list(
              ReadCapacityUnits = 123
            ),
            OnDemandThroughputOverride = list(
              MaxReadRequestUnits = 123
            )
          )
        ),
        TableClassOverride = "STANDARD"|"STANDARD_INFREQUENT_ACCESS"
      ),
      Update = list(
        RegionName = "string",
        KMSMasterKeyId = "string",
        ProvisionedThroughputOverride = list(
          ReadCapacityUnits = 123
        ),
        OnDemandThroughputOverride = list(
          MaxReadRequestUnits = 123
        ),
        GlobalSecondaryIndexes = list(
          list(
            IndexName = "string",
            ProvisionedThroughputOverride = list(
              ReadCapacityUnits = 123
            ),
            OnDemandThroughputOverride = list(
              MaxReadRequestUnits = 123
            )
          )
        ),
        TableClassOverride = "STANDARD"|"STANDARD_INFREQUENT_ACCESS"
      ),
      Delete = list(
        RegionName = "string"
      )
    )
  ),
  TableClass = "STANDARD"|"STANDARD_INFREQUENT_ACCESS",
  DeletionProtectionEnabled = TRUE|FALSE,
  MultiRegionConsistency = "EVENTUAL"|"STRONG",
  OnDemandThroughput = list(
    MaxReadRequestUnits = 123,
    MaxWriteRequestUnits = 123
  ),
  WarmThroughput = list(
    ReadUnitsPerSecond = 123,
    WriteUnitsPerSecond = 123
  )
)

Examples

## Not run: 
# This example increases the provisioned read and write capacity on the
# Music table.
svc$update_table(
  ProvisionedThroughput = list(
    ReadCapacityUnits = 10L,
    WriteCapacityUnits = 10L
  ),
  TableName = "MusicCollection"
)

## End(Not run)