aws-cdk-lib.aws_cassandra.CfnTableProps

CfnTableProps Struct

Properties for defining a CfnTable.

CfnTableProps

used as props by

• CfnTable

Source

Generated code

Type last changed

v2.230.0 · 26 Nov 2025

Example

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

  // the properties below are optional
  autoScalingSpecifications: {
    readCapacityAutoScaling: {
      autoScalingDisabled: false,
      maximumUnits: 123,
      minimumUnits: 123,
      scalingPolicy: {
        targetTrackingScalingPolicyConfiguration: {
          targetValue: 123,

          // the properties below are optional
          disableScaleIn: false,
          scaleInCooldown: 123,
          scaleOutCooldown: 123,
        },
      },
    },
    writeCapacityAutoScaling: {
      autoScalingDisabled: false,
      maximumUnits: 123,
      minimumUnits: 123,
      scalingPolicy: {
        targetTrackingScalingPolicyConfiguration: {
          targetValue: 123,

          // the properties below are optional
          disableScaleIn: false,
          scaleInCooldown: 123,
          scaleOutCooldown: 123,
        },
      },
    },
  },
  billingMode: {
    mode: 'mode',

    // the properties below are optional
    provisionedThroughput: {
      readCapacityUnits: 123,
      writeCapacityUnits: 123,
    },
  },
  cdcSpecification: {
    status: 'status',

    // the properties below are optional
    tags: [{
      key: 'key',
      value: 'value',
    }],
    viewType: 'viewType',
  },
  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',
  }],
  replicaSpecifications: [{
    region: 'region',

    // the properties below are optional
    readCapacityAutoScaling: {
      autoScalingDisabled: false,
      maximumUnits: 123,
      minimumUnits: 123,
      scalingPolicy: {
        targetTrackingScalingPolicyConfiguration: {
          targetValue: 123,

          // the properties below are optional
          disableScaleIn: false,
          scaleInCooldown: 123,
          scaleOutCooldown: 123,
        },
      },
    },
    readCapacityUnits: 123,
  }],
  tableName: 'tableName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  warmThroughput: {
    readUnitsPerSecond: 123,
    writeUnitsPerSecond: 123,
  },
};

Properties

autoScalingSpecifications?optionalIResolvable | CfnTable.AutoScalingSpecificationPropertyauto_scaling_specifications?optionaltyping.Union[IResolvable, AutoScalingSpecificationProperty]autoScalingSpecifications?optionalIResolvableAutoScalingSpecifications?optionalIResolvableAutoScalingSpecifications?optionalinterface{}#

The optional auto scaling capacity settings for a table in provisioned capacity mode.

billingMode?optionalIResolvable | CfnTable.BillingModePropertybilling_mode?optionaltyping.Union[IResolvable, BillingModeProperty]billingMode?optionalIResolvableBillingMode?optionalIResolvableBillingMode?optionalinterface{}#

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

notes

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

cdcSpecification?optionalIResolvable | CfnTable.CdcSpecificationPropertycdc_specification?optionaltyping.Union[IResolvable, CdcSpecificationProperty]cdcSpecification?optionalIResolvableCdcSpecification?optionalIResolvableCdcSpecification?optionalinterface{}#

The settings for the CDC stream of a table.

For more information about CDC streams, see Working with change data capture (CDC) streams in Amazon Keyspaces in the Amazon Keyspaces Developer Guide .

clientSideTimestampsEnabled?optionalboolean | IResolvableclient_side_timestamps_enabled?optionaltyping.Union[bool, IResolvable]clientSideTimestampsEnabled?optionalBooleanClientSideTimestampsEnabled?optionalboolClientSideTimestampsEnabled?optionalinterface{}#

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?optionalIResolvable | IResolvable | CfnTable.ClusteringKeyColumnProperty[]clustering_key_columns?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ClusteringKeyColumnProperty]]]clusteringKeyColumns?optionalIResolvableClusteringKeyColumns?optionalIResolvableClusteringKeyColumns?optionalinterface{}#

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

defaultTimeToLive?optionalnumberdefault_time_to_live?optionalint | floatdefaultTimeToLive?optionalNumberDefaultTimeToLive?optionaldoubleDefaultTimeToLive?optional*float64#

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

notes

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?optionalIResolvable | CfnTable.EncryptionSpecificationPropertyencryption_specification?optionaltyping.Union[IResolvable, EncryptionSpecificationProperty]encryptionSpecification?optionalIResolvableEncryptionSpecification?optionalIResolvableEncryptionSpecification?optionalinterface{}#

The encryption at rest options for the table.

notes

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

keyspaceNamestringkeyspace_namestrkeyspaceNameStringKeyspaceNamestringKeyspaceName*stringrequired#

The name of the keyspace to create the table in.

The keyspace must already exist.

partitionKeyColumnsIResolvable | IResolvable | CfnTable.ColumnProperty[]partition_key_columnstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ColumnProperty]]]partitionKeyColumnsIResolvablePartitionKeyColumnsIResolvablePartitionKeyColumnsinterface{}required#

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

Every table must have a partition key.

pointInTimeRecoveryEnabled?optionalboolean | IResolvablepoint_in_time_recovery_enabled?optionaltyping.Union[bool, IResolvable]pointInTimeRecoveryEnabled?optionalBooleanPointInTimeRecoveryEnabled?optionalboolPointInTimeRecoveryEnabled?optionalinterface{}#

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?optionalIResolvable | IResolvable | CfnTable.ColumnProperty[]regular_columns?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ColumnProperty]]]regularColumns?optionalIResolvableRegularColumns?optionalIResolvableRegularColumns?optionalinterface{}#

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.

replicaSpecifications?optionalIResolvable | IResolvable | CfnTable.ReplicaSpecificationProperty[]replica_specifications?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicaSpecificationProperty]]]replicaSpecifications?optionalIResolvableReplicaSpecifications?optionalIResolvableReplicaSpecifications?optionalinterface{}#

The AWS Region specific settings of a multi-Region table.

notes

For a multi-Region table, you can configure the table's read capacity differently per AWS Region. You can do this 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)

tableName?optionalstringtable_name?optionalstrtableName?optionalStringTableName?optionalstringTableName?optional*string#

The name of the table to be created.

notes

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?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

An array of key-value pairs to apply to this resource.

For more information, see Tag .

warmThroughput?optionalIResolvable | CfnTable.WarmThroughputPropertywarm_throughput?optionaltyping.Union[IResolvable, WarmThroughputProperty]warmThroughput?optionalIResolvableWarmThroughput?optionalIResolvableWarmThroughput?optionalinterface{}#

Warm throughput configuration for the table.