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 CreateTable API operation.

Syntax

New-KSTable
-SchemaDefinition_AllColumn <ColumnDefinition[]>
-ReadCapacityAutoScaling_AutoScalingDisabled <Boolean>
-WriteCapacityAutoScaling_AutoScalingDisabled <Boolean>
-SchemaDefinition_ClusteringKey <ClusteringKey[]>
-DefaultTimeToLive <Int32>
-ReadCapacity_TargetTrackingScalingPolicyConfiguration_DisableScaleIn <Boolean>
-WriteCapacity_TargetTrackingScalingPolicyConfiguration_DisableScaleIn <Boolean>
-KeyspaceName <String>
-EncryptionSpecification_KmsKeyIdentifier <String>
-ReadCapacityAutoScaling_MaximumUnit <Int64>
-WriteCapacityAutoScaling_MaximumUnit <Int64>
-Comment_Message <String>
-ReadCapacityAutoScaling_MinimumUnit <Int64>
-WriteCapacityAutoScaling_MinimumUnit <Int64>
-SchemaDefinition_PartitionKey <PartitionKey[]>
-CdcSpecification_PropagateTag <CdcPropagateTags>
-CapacitySpecification_ReadCapacityUnit <Int64>
-ReplicaSpecification <ReplicaSpecification[]>
-ReadCapacity_TargetTrackingScalingPolicyConfiguration_ScaleInCooldown <Int32>
-WriteCapacity_TargetTrackingScalingPolicyConfiguration_ScaleInCooldown <Int32>
-ReadCapacity_TargetTrackingScalingPolicyConfiguration_ScaleOutCooldown <Int32>
-WriteCapacity_TargetTrackingScalingPolicyConfiguration_ScaleOutCooldown <Int32>
-SchemaDefinition_StaticColumn <StaticColumn[]>
-CdcSpecification_Status <CdcStatus>
-ClientSideTimestamps_Status <ClientSideTimestampsStatus>
-PointInTimeRecovery_Status <PointInTimeRecoveryStatus>
-Ttl_Status <TimeToLiveStatus>
-TableName <String>
-CdcSpecification_Tag <Tag[]>
-Tag <Tag[]>
-ReadCapacity_TargetTrackingScalingPolicyConfiguration_TargetValue <Double>
-WriteCapacity_TargetTrackingScalingPolicyConfiguration_TargetValue <Double>
-CapacitySpecification_ThroughputMode <ThroughputMode>
-EncryptionSpecification_Type <EncryptionType>
-CdcSpecification_ViewType <ViewType>
-CapacitySpecification_WriteCapacityUnit <Int64>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonKeyspacesConfig>

Description

The CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique. CreateTable is an asynchronous operation. When the request is received, the status of the table is set to CREATING. You can monitor the creation status of the new table by using the GetTable operation, which returns the current status of the table. You can start using a table when the status is ACTIVE. For more information, see Create a table in the Amazon Keyspaces Developer Guide.

Parameters

-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
-CdcSpecification_PropagateTag <CdcPropagateTags>
Specifies that the stream inherits the tags from the table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCdcSpecification_PropagateTags
-CdcSpecification_Status <CdcStatus>
The status of the CDC stream. You can enable or disable a stream for a table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CdcSpecification_Tag <Tag[]>
The tags (key-value pairs) that you want to apply to the stream. 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)
AliasesCdcSpecification_Tags
-CdcSpecification_ViewType <ViewType>
The view type specifies the changes Amazon Keyspaces records for each changed row in the stream. After you create the stream, you can't make changes to this selection.The options are:
  • NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.
  • NEW_IMAGE - the version of the row after the change.
  • OLD_IMAGE - the version of the row before the change.
  • KEYS_ONLY - the partition and clustering keys of the row that was changed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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)
-Comment_Message <String>
An optional description of the 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 that the table is going to be created 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 optional Amazon Web Services Region specific settings of a multi-Region table. These settings overwrite the general settings of the table for the specified Region.For a multi-Region table in provisioned capacity mode, you can configure the table's read capacity differently for each Region's replica. The write capacity, however, remains synchronized between all replicas to ensure that there's enough capacity to replicate writes across all Regions. To define the read capacity for a table replica in a specific Region, you can do so by configuring the following parameters.
  • region: The Region where these settings are applied. (Required)
  • readCapacityUnits: The provisioned read capacity units. (Optional)
  • readCapacityAutoScaling: The read capacity auto scaling settings for the table. (Optional)
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)
AliasesReplicaSpecifications
-SchemaDefinition_AllColumn <ColumnDefinition[]>
The regular columns of 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?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSchemaDefinition_AllColumns
-SchemaDefinition_ClusteringKey <ClusteringKey[]>
The columns that are part of the clustering key of 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)
AliasesSchemaDefinition_ClusteringKeys
-SchemaDefinition_PartitionKey <PartitionKey[]>
The columns that are part of the partition key of 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?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSchemaDefinition_PartitionKeys
-SchemaDefinition_StaticColumn <StaticColumn[]>
The columns that have been defined as STATIC. Static columns store values that are shared by all rows in the same partition. 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)
AliasesSchemaDefinition_StaticColumns
-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.CreateTableResponse). Specifying the name of a property of type Amazon.Keyspaces.Model.CreateTableResponse 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)
-Tag <Tag[]>
A list of key-value pair tags to be attached to the resource. For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces 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)
AliasesTags
-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.CreateTableResponse
This cmdlet returns a System.String object. The service call response (type Amazon.Keyspaces.Model.CreateTableResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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