AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon DynamoDB UpdateTable API operation.

Syntax

Update-DDBTable
-TableName <String>
-AttributeDefinition <AttributeDefinition[]>
-BillingMode <BillingMode>
-DeletionProtectionEnabled <Boolean>
-SSESpecification_Enabled <Boolean>
-GlobalSecondaryIndexUpdate <GlobalSecondaryIndexUpdate[]>
-GlobalTableWitnessUpdate <GlobalTableWitnessGroupUpdate[]>
-SSESpecification_KMSMasterKeyId <String>
-OnDemandThroughput_MaxReadRequestUnit <Int64>
-OnDemandThroughput_MaxWriteRequestUnit <Int64>
-MultiRegionConsistency <MultiRegionConsistency>
-ReadCapacity <Int64>
-WarmThroughput_ReadUnitsPerSecond <Int64>
-ReplicaUpdate <ReplicationGroupUpdate[]>
-SSESpecification_SSEType <SSEType>
-StreamSpecification_StreamEnabled <Boolean>
-StreamSpecification_StreamViewType <StreamViewType>
-TableClass <TableClass>
-WriteCapacity <Int64>
-WarmThroughput_WriteUnitsPerSecond <Int64>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonDynamoDBConfig>

Description

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table. 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 UpdateTable to perform other operations.
UpdateTable 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 UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.

Parameters

-AttributeDefinition <AttributeDefinition[]>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAttributeDefinitions
-BillingMode <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.
  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
  • PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity mode.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonDynamoDBConfig>
Amazon.PowerShell.Cmdlets.DDB.AmazonDynamoDBClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeletionProtectionEnabled <Boolean>
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GlobalSecondaryIndexUpdate <GlobalSecondaryIndexUpdate[]>
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 UpdateTable operation.For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGlobalSecondaryIndexUpdates
-GlobalTableWitnessUpdate <GlobalTableWitnessGroupUpdate[]>
A list of witness updates for a MRSC global table. A witness provides a cost-effective alternative to a full replica in a MRSC global table by maintaining replicated change data written to global table replicas. You cannot perform read or write operations on a witness. For each witness, you can request one action:
  • Create - add a new witness to the global table.
  • Delete - remove a witness from the global table.
You can create or delete only one witness per UpdateTable operation.For more information, see Multi-Region strong consistency (MRSC) in the Amazon DynamoDB Developer Guide Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGlobalTableWitnessUpdates
-MultiRegionConsistency <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 (MREC). This is the default consistency mode for global tables.
  • STRONG: Configures a new global table for multi-Region strong consistency (MRSC).
If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OnDemandThroughput_MaxReadRequestUnit <Int64>
Maximum number of read request units for the specified table.To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDemandThroughput_MaxReadRequestUnits
-OnDemandThroughput_MaxWriteRequestUnit <Int64>
Maximum number of write request units for the specified table.To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDemandThroughput_MaxWriteRequestUnits
-ReadCapacity <Int64>
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProvisionedThroughput_ReadCapacityUnits
-ReplicaUpdate <ReplicationGroupUpdate[]>
A list of replica update actions (create, delete, or update) for the table. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReplicaUpdates
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'TableDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DynamoDBv2.Model.UpdateTableResponse). Specifying the name of a property of type Amazon.DynamoDBv2.Model.UpdateTableResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SSESpecification_Enabled <Boolean>
Indicates whether server-side encryption is done using an Amazon Web Services managed key or an Amazon Web Services owned key. If enabled (true), server-side encryption type is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to Amazon Web Services owned key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SSESpecification_KMSMasterKeyId <String>
The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SSESpecification_SSEType <SSEType>
Server-side encryption type. The only supported value is:
  • KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StreamSpecification_StreamEnabled <Boolean>
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StreamSpecification_StreamViewType <StreamViewType>
When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:
  • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
  • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
  • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
  • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TableClass <TableClass>
The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TableName <String>
The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-WarmThroughput_ReadUnitsPerSecond <Int64>
Represents the number of read operations your base table can instantaneously support.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WarmThroughput_WriteUnitsPerSecond <Int64>
Represents the number of write operations your base table can instantaneously support.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteCapacity <Int64>
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProvisionedThroughput_WriteCapacityUnits

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.DynamoDBv2.Model.TableDescription or Amazon.DynamoDBv2.Model.UpdateTableResponse
This cmdlet returns an Amazon.DynamoDBv2.Model.TableDescription object. The service call response (type Amazon.DynamoDBv2.Model.UpdateTableResponse) can be returned by specifying '-Select *'.

Examples

Example 1

Update-DDBTable -TableName "myTable" -ReadCapacity 10 -WriteCapacity 5
Updates the provisioned throughput for the given table.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z