CreateTableCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { KeyspacesClient, CreateTableCommand } from "@aws-sdk/client-keyspaces"; // ES Modules import
// const { KeyspacesClient, CreateTableCommand } = require("@aws-sdk/client-keyspaces"); // CommonJS import
const client = new KeyspacesClient(config);
const input = { // CreateTableRequest
  keyspaceName: "STRING_VALUE", // required
  tableName: "STRING_VALUE", // required
  schemaDefinition: { // SchemaDefinition
    allColumns: [ // ColumnDefinitionList // required
      { // ColumnDefinition
        name: "STRING_VALUE", // required
        type: "STRING_VALUE", // required
      },
    ],
    partitionKeys: [ // PartitionKeyList // required
      { // PartitionKey
        name: "STRING_VALUE", // required
      },
    ],
    clusteringKeys: [ // ClusteringKeyList
      { // ClusteringKey
        name: "STRING_VALUE", // required
        orderBy: "STRING_VALUE", // required
      },
    ],
    staticColumns: [ // StaticColumnList
      { // StaticColumn
        name: "STRING_VALUE", // required
      },
    ],
  },
  comment: { // Comment
    message: "STRING_VALUE", // required
  },
  capacitySpecification: { // CapacitySpecification
    throughputMode: "STRING_VALUE", // required
    readCapacityUnits: Number("long"),
    writeCapacityUnits: Number("long"),
  },
  encryptionSpecification: { // EncryptionSpecification
    type: "STRING_VALUE", // required
    kmsKeyIdentifier: "STRING_VALUE",
  },
  pointInTimeRecovery: { // PointInTimeRecovery
    status: "STRING_VALUE", // required
  },
  ttl: { // TimeToLive
    status: "STRING_VALUE", // required
  },
  defaultTimeToLive: Number("int"),
  tags: [ // TagList
    { // Tag
      key: "STRING_VALUE", // required
      value: "STRING_VALUE", // required
    },
  ],
  clientSideTimestamps: { // ClientSideTimestamps
    status: "STRING_VALUE", // required
  },
  autoScalingSpecification: { // AutoScalingSpecification
    writeCapacityAutoScaling: { // AutoScalingSettings
      autoScalingDisabled: true || false,
      minimumUnits: Number("long"),
      maximumUnits: Number("long"),
      scalingPolicy: { // AutoScalingPolicy
        targetTrackingScalingPolicyConfiguration: { // TargetTrackingScalingPolicyConfiguration
          disableScaleIn: true || false,
          scaleInCooldown: Number("int"),
          scaleOutCooldown: Number("int"),
          targetValue: Number("double"), // required
        },
      },
    },
    readCapacityAutoScaling: {
      autoScalingDisabled: true || false,
      minimumUnits: Number("long"),
      maximumUnits: Number("long"),
      scalingPolicy: {
        targetTrackingScalingPolicyConfiguration: {
          disableScaleIn: true || false,
          scaleInCooldown: Number("int"),
          scaleOutCooldown: Number("int"),
          targetValue: Number("double"), // required
        },
      },
    },
  },
  replicaSpecifications: [ // ReplicaSpecificationList
    { // ReplicaSpecification
      region: "STRING_VALUE", // required
      readCapacityUnits: Number("long"),
      readCapacityAutoScaling: {
        autoScalingDisabled: true || false,
        minimumUnits: Number("long"),
        maximumUnits: Number("long"),
        scalingPolicy: {
          targetTrackingScalingPolicyConfiguration: {
            disableScaleIn: true || false,
            scaleInCooldown: Number("int"),
            scaleOutCooldown: Number("int"),
            targetValue: Number("double"), // required
          },
        },
      },
    },
  ],
};
const command = new CreateTableCommand(input);
const response = await client.send(command);
// { // CreateTableResponse
//   resourceArn: "STRING_VALUE", // required
// };

CreateTableCommand Input

See CreateTableCommandInput for more details

Parameter
Type
Description
keyspaceName
Required
string | undefined

The name of the keyspace that the table is going to be created in.

schemaDefinition
Required
SchemaDefinition | undefined

The schemaDefinition consists of the following parameters.

For each column to be created:

  • name - The name of the column.

  • type - An Amazon Keyspaces data type. For more information, see Data types  in the Amazon Keyspaces Developer Guide.

The primary key of the table consists of the following columns:

  • partitionKeys - The partition key can be a single column, or it can be a compound value composed of two or more columns. The partition key portion of the primary key is required and determines how Amazon Keyspaces stores your data.

  • name - The name of each partition key column.

  • clusteringKeys - The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.

  • name - The name of the clustering column.

  • orderBy - Sets the ascendant (ASC) or descendant (DESC) order modifier.

    To define a column as static use staticColumns - Static columns store values that are shared by all rows in the same partition:

  • name - The name of the column.

  • type - An Amazon Keyspaces data type.

tableName
Required
string | undefined

The name of the table.

autoScalingSpecification
AutoScalingSpecification | undefined

The optional auto scaling settings for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity automatically on your behalf.

Auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling  in the Amazon Keyspaces Developer Guide.

By default, auto scaling is disabled for a table.

capacitySpecification
CapacitySpecification | undefined

Specifies the read/write throughput capacity mode for the 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.

clientSideTimestamps
ClientSideTimestamps | undefined

Enables client-side timestamps for the table. By default, the setting is disabled. You can enable client-side timestamps with the following option:

  • status: "enabled"

Once client-side timestamps are enabled for a table, this setting cannot be disabled.

comment
Comment | undefined

This parameter allows to enter a description of the table.

defaultTimeToLive
number | undefined

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.

encryptionSpecification
EncryptionSpecification | undefined

Specifies how the encryption key for encryption at rest is managed for the table. You can choose one of the following KMS key (KMS key):

  • 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.

pointInTimeRecovery
PointInTimeRecovery | undefined

Specifies if pointInTimeRecovery is enabled or disabled for the table. The options are:

  • status=ENABLED

  • status=DISABLED

If it's not specified, the default is status=DISABLED.

For more information, see Point-in-time recovery  in the Amazon Keyspaces Developer Guide.

replicaSpecifications
ReplicaSpecification[] | undefined

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)

tags
Tag[] | undefined

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.

ttl
TimeToLive | undefined

Enables Time to Live custom settings for the table. The options are:

  • status:enabled

  • status:disabled

The default is status:disabled. After ttl is enabled, you can't disable it for the table.

For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL)  in the Amazon Keyspaces Developer Guide.

CreateTableCommand Output

See CreateTableCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
resourceArn
Required
string | undefined

The unique identifier of the table in the format of an Amazon Resource Name (ARN).

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have sufficient access permissions to perform this action.

ConflictException
client

Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.

InternalServerException
server

Amazon Keyspaces was unable to fully process this request because of an internal server error.

ResourceNotFoundException
client

The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be ACTIVE.

ServiceQuotaExceededException
client

The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas  in the Amazon Keyspaces Developer Guide.

ValidationException
client

The operation failed due to an invalid or malformed request.

KeyspacesServiceException
Base exception class for all service exceptions from Keyspaces service.