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 Keyspaces UpdateTable API operation.

Syntax

Update-KSTable
-AddColumn <ColumnDefinition[]>
-ReadCapacityAutoScaling_AutoScalingDisabled <Boolean>
-WriteCapacityAutoScaling_AutoScalingDisabled <Boolean>
-DefaultTimeToLive <Int32>
-ReadCapacity_TargetTrackingScalingPolicyConfiguration_DisableScaleIn <Boolean>
-WriteCapacity_TargetTrackingScalingPolicyConfiguration_DisableScaleIn <Boolean>
-KeyspaceName <String>
-EncryptionSpecification_KmsKeyIdentifier <String>
-ReadCapacityAutoScaling_MaximumUnit <Int64>
-WriteCapacityAutoScaling_MaximumUnit <Int64>
-ReadCapacityAutoScaling_MinimumUnit <Int64>
-WriteCapacityAutoScaling_MinimumUnit <Int64>
-CapacitySpecification_ReadCapacityUnit <Int64>
-ReplicaSpecification <ReplicaSpecification[]>
-ReadCapacity_TargetTrackingScalingPolicyConfiguration_ScaleInCooldown <Int32>
-WriteCapacity_TargetTrackingScalingPolicyConfiguration_ScaleInCooldown <Int32>
-ReadCapacity_TargetTrackingScalingPolicyConfiguration_ScaleOutCooldown <Int32>
-WriteCapacity_TargetTrackingScalingPolicyConfiguration_ScaleOutCooldown <Int32>
-ClientSideTimestamps_Status <ClientSideTimestampsStatus>
-PointInTimeRecovery_Status <PointInTimeRecoveryStatus>
-Ttl_Status <TimeToLiveStatus>
-TableName <String>
-ReadCapacity_TargetTrackingScalingPolicyConfiguration_TargetValue <Double>
-WriteCapacity_TargetTrackingScalingPolicyConfiguration_TargetValue <Double>
-CapacitySpecification_ThroughputMode <ThroughputMode>
-EncryptionSpecification_Type <EncryptionType>
-CapacitySpecification_WriteCapacityUnit <Int64>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonKeyspacesConfig>

Description

Adds new columns to the table or updates one of the table's settings, for example capacity mode, auto scaling, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.

Parameters

-AddColumn <ColumnDefinition[]>
For each column to be added to the specified table:
  • name - The name of the column.
  • type - An Amazon Keyspaces data type. For more information, see Data types in the Amazon Keyspaces Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAddColumns
-CapacitySpecification_ReadCapacityUnit <Int64>
The throughput capacity specified for read operations defined in read capacity units(RCUs).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapacitySpecification_ReadCapacityUnits
-CapacitySpecification_ThroughputMode <ThroughputMode>
The read/write throughput capacity mode for a table. The options are:
  • throughputMode:PAY_PER_REQUEST and
  • throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.
The default is throughput_mode:PAY_PER_REQUEST.For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CapacitySpecification_WriteCapacityUnit <Int64>
The throughput capacity specified for write operations defined in write capacity units(WCUs).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapacitySpecification_WriteCapacityUnits
-ClientConfig <AmazonKeyspacesConfig>
Amazon.PowerShell.Cmdlets.KS.AmazonKeyspacesClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientSideTimestamps_Status <ClientSideTimestampsStatus>
Shows how to enable client-side timestamps settings for the specified table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultTimeToLive <Int32>
The default Time to Live setting in seconds for the table.For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionSpecification_KmsKeyIdentifier <String>
The Amazon Resource Name (ARN) of the customer managed KMS key, for example kms_key_identifier:ARN.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionSpecification_Type <EncryptionType>
The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):
  • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.
  • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.
The default is type:AWS_OWNED_KMS_KEY. For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
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)
-KeyspaceName <String>
The name of the keyspace the specified table is stored in.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PointInTimeRecovery_Status <PointInTimeRecoveryStatus>
The options are:
  • status=ENABLED
  • status=DISABLED
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReadCapacity_TargetTrackingScalingPolicyConfiguration_DisableScaleIn <Boolean>
Specifies if scale-in is enabled.When auto scaling automatically decreases capacity for a table, the table scales in. When scaling policies are set, they can't scale in the table lower than its minimum capacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingSpecification_ReadCapacityAutoScaling_ScalingPolicy_TargetTrackingScalingPolicyConfiguration_DisableScaleIn
-ReadCapacity_TargetTrackingScalingPolicyConfiguration_ScaleInCooldown <Int32>
Specifies a scale-in cool down period.A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingSpecification_ReadCapacityAutoScaling_ScalingPolicy_TargetTrackingScalingPolicyConfiguration_ScaleInCooldown
-ReadCapacity_TargetTrackingScalingPolicyConfiguration_ScaleOutCooldown <Int32>
Specifies a scale out cool down period.A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingSpecification_ReadCapacityAutoScaling_ScalingPolicy_TargetTrackingScalingPolicyConfiguration_ScaleOutCooldown
-ReadCapacity_TargetTrackingScalingPolicyConfiguration_TargetValue <Double>
Specifies the target value for the target tracking auto scaling policy.Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingSpecification_ReadCapacityAutoScaling_ScalingPolicy_TargetTrackingScalingPolicyConfiguration_TargetValue
-ReadCapacityAutoScaling_AutoScalingDisabled <Boolean>
This optional parameter enables auto scaling for the table if set to false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingSpecification_ReadCapacityAutoScaling_AutoScalingDisabled
-ReadCapacityAutoScaling_MaximumUnit <Int64>
Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingSpecification_ReadCapacityAutoScaling_MaximumUnits
-ReadCapacityAutoScaling_MinimumUnit <Int64>
The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingSpecification_ReadCapacityAutoScaling_MinimumUnits
-ReplicaSpecification <ReplicaSpecification[]>
The Region specific settings of a multi-Regional table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReplicaSpecifications
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ResourceArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Keyspaces.Model.UpdateTableResponse). Specifying the name of a property of type Amazon.Keyspaces.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)
-TableName <String>
The name of the table.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Ttl_Status <TimeToLiveStatus>
Shows how to enable custom Time to Live (TTL) settings for the specified table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WriteCapacity_TargetTrackingScalingPolicyConfiguration_DisableScaleIn <Boolean>
Specifies if scale-in is enabled.When auto scaling automatically decreases capacity for a table, the table scales in. When scaling policies are set, they can't scale in the table lower than its minimum capacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingSpecification_WriteCapacityAutoScaling_ScalingPolicy_TargetTrackingScalingPolicyConfiguration_DisableScaleIn
-WriteCapacity_TargetTrackingScalingPolicyConfiguration_ScaleInCooldown <Int32>
Specifies a scale-in cool down period.A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingSpecification_WriteCapacityAutoScaling_ScalingPolicy_TargetTrackingScalingPolicyConfiguration_ScaleInCooldown
-WriteCapacity_TargetTrackingScalingPolicyConfiguration_ScaleOutCooldown <Int32>
Specifies a scale out cool down period.A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingSpecification_WriteCapacityAutoScaling_ScalingPolicy_TargetTrackingScalingPolicyConfiguration_ScaleOutCooldown
-WriteCapacity_TargetTrackingScalingPolicyConfiguration_TargetValue <Double>
Specifies the target value for the target tracking auto scaling policy.Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define targetValue as a percentage. A double between 20 and 90.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingSpecification_WriteCapacityAutoScaling_ScalingPolicy_TargetTrackingScalingPolicyConfiguration_TargetValue
-WriteCapacityAutoScaling_AutoScalingDisabled <Boolean>
This optional parameter enables auto scaling for the table if set to false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingSpecification_WriteCapacityAutoScaling_AutoScalingDisabled
-WriteCapacityAutoScaling_MaximumUnit <Int64>
Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingSpecification_WriteCapacityAutoScaling_MaximumUnits
-WriteCapacityAutoScaling_MinimumUnit <Int64>
The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoScalingSpecification_WriteCapacityAutoScaling_MinimumUnits

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

System.String or Amazon.Keyspaces.Model.UpdateTableResponse
This cmdlet returns a System.String object. The service call response (type Amazon.Keyspaces.Model.UpdateTableResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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