Skip to content

Create Table

keyspaces_create_table R Documentation

The CreateTable operation adds a new table to the specified keyspace

Description

The create_table operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique.

create_table 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 get_table operation, which returns the current status of the table. You can start using a table when the status is ACTIVE.

For more information, see Creating tables in the Amazon Keyspaces Developer Guide.

Usage

keyspaces_create_table(keyspaceName, tableName, schemaDefinition,
  comment, capacitySpecification, encryptionSpecification,
  pointInTimeRecovery, ttl, defaultTimeToLive, tags, clientSideTimestamps,
  autoScalingSpecification, replicaSpecifications)

Arguments

keyspaceName

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

tableName

[required] The name of the table.

schemaDefinition

[required] 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.

comment

This parameter allows to enter a description of the table.

capacitySpecification

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.

encryptionSpecification

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

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.

ttl

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.

defaultTimeToLive

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.

tags

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.

clientSideTimestamps

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.

autoScalingSpecification

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.

replicaSpecifications

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)

Value

A list with the following syntax: 

list(
  resourceArn = "string"
)

Request syntax

svc$create_table(
  keyspaceName = "string",
  tableName = "string",
  schemaDefinition = list(
    allColumns = list(
      list(
        name = "string",
        type = "string"
      )
    ),
    partitionKeys = list(
      list(
        name = "string"
      )
    ),
    clusteringKeys = list(
      list(
        name = "string",
        orderBy = "ASC"|"DESC"
      )
    ),
    staticColumns = list(
      list(
        name = "string"
      )
    )
  ),
  comment = list(
    message = "string"
  ),
  capacitySpecification = list(
    throughputMode = "PAY_PER_REQUEST"|"PROVISIONED",
    readCapacityUnits = 123,
    writeCapacityUnits = 123
  ),
  encryptionSpecification = list(
    type = "CUSTOMER_MANAGED_KMS_KEY"|"AWS_OWNED_KMS_KEY",
    kmsKeyIdentifier = "string"
  ),
  pointInTimeRecovery = list(
    status = "ENABLED"|"DISABLED"
  ),
  ttl = list(
    status = "ENABLED"
  ),
  defaultTimeToLive = 123,
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  clientSideTimestamps = list(
    status = "ENABLED"
  ),
  autoScalingSpecification = list(
    writeCapacityAutoScaling = list(
      autoScalingDisabled = TRUE|FALSE,
      minimumUnits = 123,
      maximumUnits = 123,
      scalingPolicy = list(
        targetTrackingScalingPolicyConfiguration = list(
          disableScaleIn = TRUE|FALSE,
          scaleInCooldown = 123,
          scaleOutCooldown = 123,
          targetValue = 123.0
        )
      )
    ),
    readCapacityAutoScaling = list(
      autoScalingDisabled = TRUE|FALSE,
      minimumUnits = 123,
      maximumUnits = 123,
      scalingPolicy = list(
        targetTrackingScalingPolicyConfiguration = list(
          disableScaleIn = TRUE|FALSE,
          scaleInCooldown = 123,
          scaleOutCooldown = 123,
          targetValue = 123.0
        )
      )
    )
  ),
  replicaSpecifications = list(
    list(
      region = "string",
      readCapacityUnits = 123,
      readCapacityAutoScaling = list(
        autoScalingDisabled = TRUE|FALSE,
        minimumUnits = 123,
        maximumUnits = 123,
        scalingPolicy = list(
          targetTrackingScalingPolicyConfiguration = list(
            disableScaleIn = TRUE|FALSE,
            scaleInCooldown = 123,
            scaleOutCooldown = 123,
            targetValue = 123.0
          )
        )
      )
    )
  )
)