Synopsis
Calls the Amazon DynamoDB UpdateTable API operation.
Syntax
Update-DDBTable-TableName <String>-AttributeDefinition <AttributeDefinition[]>-BillingMode <BillingMode>-SSESpecification_Enabled <Boolean>-GlobalSecondaryIndexUpdate <GlobalSecondaryIndexUpdate[]>-SSESpecification_KMSMasterKeyId <String>-ReadCapacity <Int64>-SSESpecification_SSEType <SSEType>-StreamSpecification_StreamEnabled <Boolean>-StreamSpecification_StreamViewType <StreamViewType>-WriteCapacity <Int64>-Force <SwitchParameter>
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.
- Enable or disable Streams on the table.
- Remove a global secondary index from the table.
- Create a new global secondary index on the table. Once the index begins backfilling, you can use
UpdateTableto perform other operations.
UpdateTable is an asynchronous operation; while it is executing, the table status changes from ACTIVE to UPDATING. While it is UPDATING, you cannot 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. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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.
PROVISIONED- Sets the billing mode toPROVISIONED. We recommend usingPROVISIONEDfor predictable workloads.PAY_PER_REQUEST- Sets the billing mode toPAY_PER_REQUEST. We recommend usingPAY_PER_REQUESTfor unpredictable workloads.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
-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.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
-SSESpecification_Enabled <Boolean>
Indicates whether server-side encryption is enabled (true) or disabled (false) on the table. If enabled (true), server-side encryption type is set to
KMS. If disabled (false) or not specified, server-side encryption is set to AWS owned CMK. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SSESpecification_KMSMasterKeyId <String>
The KMS Master Key (CMK) which should be used for the KMS encryption. To specify a CMK, 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 KMS Master Key alias/aws/dynamodb.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SSESpecification_SSEType <SSEType>
Server-side encryption type:
AES256- Server-side encryption which uses the AES256 algorithm (not applicable).KMS- Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-StreamSpecification_StreamEnabled <Boolean>
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
-TableName <String>
The name of the table to be updated.
| Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, 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? | False |
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? | False |
-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? | False |
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
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? | False |
-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? | False |
-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? | False |
-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? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
Inputs
You can pipe a String object to this cmdlet for the TableName parameter.
Outputs
This cmdlet returns a TableDescription object.
The service call response (type Amazon.DynamoDBv2.Model.UpdateTableResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Examples
Example 1
PS C:\>Update-DDBTable -TableName "myTable" -ReadCapacity 10 -WriteCapacity 5Updates the provisioned throughput for the given table.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
