interface CfnTableProps

Language	Type name
.NET	`Amazon.CDK.AWS.Cassandra.CfnTableProps`
Java	`software.amazon.awscdk.services.cassandra.CfnTableProps`
Python	`aws_cdk.aws_cassandra.CfnTableProps`
TypeScript	`@aws-cdk/aws-cassandra` » `CfnTableProps`

Properties for defining a CfnTable.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cassandra from '@aws-cdk/aws-cassandra';
const cfnTableProps: cassandra.CfnTableProps = {
  keyspaceName: 'keyspaceName',
  partitionKeyColumns: [{
    columnName: 'columnName',
    columnType: 'columnType',
  }],

  // the properties below are optional
  billingMode: {
    mode: 'mode',

    // the properties below are optional
    provisionedThroughput: {
      readCapacityUnits: 123,
      writeCapacityUnits: 123,
    },
  },
  clientSideTimestampsEnabled: false,
  clusteringKeyColumns: [{
    column: {
      columnName: 'columnName',
      columnType: 'columnType',
    },

    // the properties below are optional
    orderBy: 'orderBy',
  }],
  defaultTimeToLive: 123,
  encryptionSpecification: {
    encryptionType: 'encryptionType',

    // the properties below are optional
    kmsKeyIdentifier: 'kmsKeyIdentifier',
  },
  pointInTimeRecoveryEnabled: false,
  regularColumns: [{
    columnName: 'columnName',
    columnType: 'columnType',
  }],
  tableName: 'tableName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
keyspaceName	`string`	The name of the keyspace to create the table in.
partitionKeyColumns	`IResolvable` `\|` `ColumnProperty` `\|` `IResolvable[]`	One or more columns that uniquely identify every row in the table.
billingMode?	`IResolvable` `\|` `BillingModeProperty`	The billing mode for the table, which determines how you'll be charged for reads and writes:.
clientSideTimestampsEnabled?	`boolean \|` `IResolvable`	Enables client-side timestamps for the table.
clusteringKeyColumns?	`IResolvable` `\|` `IResolvable` `\|` `ClusteringKeyColumnProperty[]`	One or more columns that determine how the table data is sorted.
defaultTimeToLive?	`number`	The default Time To Live (TTL) value for all rows in a table in seconds.
encryptionSpecification?	`IResolvable` `\|` `EncryptionSpecificationProperty`	The encryption at rest options for the table.
pointInTimeRecoveryEnabled?	`boolean \|` `IResolvable`	Specifies if point-in-time recovery is enabled or disabled for the table.
regularColumns?	`IResolvable` `\|` `ColumnProperty` `\|` `IResolvable[]`	One or more columns that are not part of the primary key - that is, columns that are not defined as partition key columns or clustering key columns.
tableName?	`string`	The name of the table to be created.
tags?	`CfnTag[]`	A list of key-value pair tags to be attached to the resource.

keyspaceName

Type: string

The name of the keyspace to create the table in.

The keyspace must already exist.

partitionKeyColumns

Type: IResolvable | ColumnProperty | IResolvable[]

One or more columns that uniquely identify every row in the table.

Every table must have a partition key.

billingMode?

Type: IResolvable | BillingModeProperty (optional)

The billing mode for the table, which determines how you'll be charged for reads and writes:.

On-demand mode (default) - You pay based on the actual reads and writes your application performs.
Provisioned mode - Lets you specify the number of reads and writes per second that you need for your application.

If you don't specify a value for this property, then the table will use on-demand mode.

clientSideTimestampsEnabled?

Type: boolean | IResolvable (optional)

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"

After client-side timestamps are enabled for a table, you can't disable this setting.

clusteringKeyColumns?

Type: IResolvable | IResolvable | ClusteringKeyColumnProperty[] (optional)

One or more columns that determine how the table data is sorted.

defaultTimeToLive?

Type: number (optional)

The default Time To Live (TTL) value for all rows in a table in seconds.

The maximum configurable value is 630,720,000 seconds, which is the equivalent of 20 years. By default, the TTL value for a table is 0, which means data does not expire.

For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide .

encryptionSpecification?

Type: IResolvable | EncryptionSpecificationProperty (optional)

The encryption at rest options for the table.

AWS owned key (default) - The key is owned by Amazon Keyspaces.
Customer managed key - The key is stored in your account and is created, owned, and managed by you.

If you choose encryption with a customer managed key, you must specify a valid customer managed KMS key with permissions granted to Amazon Keyspaces.

For more information, see Encryption at rest in Amazon Keyspaces in the Amazon Keyspaces Developer Guide .

pointInTimeRecoveryEnabled?

Type: boolean | IResolvable (optional)

Specifies if point-in-time recovery is enabled or disabled for the table.

The options are PointInTimeRecoveryEnabled=true and PointInTimeRecoveryEnabled=false . If not specified, the default is PointInTimeRecoveryEnabled=false .

regularColumns?

Type: IResolvable | ColumnProperty | IResolvable[] (optional)

One or more columns that are not part of the primary key - that is, columns that are not defined as partition key columns or clustering key columns.

You can add regular columns to existing tables by adding them to the template.

tableName?

Type: string (optional)

The name of the table to be created.

The table name is case sensitive. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the table name. For more information, see Name type .

If you specify a name, you can't perform updates that require replacing this resource. You can perform updates that require no interruption or some interruption. If you must replace the resource, specify a new name.

Length constraints: Minimum length of 3. Maximum length of 255.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$

tags?

Type: CfnTag[] (optional)

A list of key-value pair tags to be attached to the resource.