class CfnTable (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.Cassandra.CfnTable`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscassandra#CfnTable`
Java	`software.amazon.awscdk.services.cassandra.CfnTable`
Python	`aws_cdk.aws_cassandra.CfnTable`
TypeScript	`aws-cdk-lib` » `aws_cassandra` » `CfnTable`

Implements IConstruct, IDependable, IInspectable, ITaggable

You can use the AWS::Cassandra::Table resource to create a new table in Amazon Keyspaces (for Apache Cassandra).

For more information, see Create a keyspace and a table in the Amazon Keyspaces Developer Guide .

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 cfnTable = new cassandra.CfnTable(this, 'MyCfnTable', {
  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,
    },
  },
  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',
  }],
});

Initializer

new CfnTable(scope: Construct, id: string, props: CfnTableProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnTableProps — Resource properties.

Construct Props

Name	Type	Description
keyspaceName	`string`	The name of the keyspace to create the table in.
partitionKeyColumns	`IResolvable` `\|` `IResolvable` `\|` `ColumnProperty[]`	One or more columns that uniquely identify every row in the table.
autoScalingSpecifications?	`IResolvable` `\|` `AutoScalingSpecificationProperty`	The optional auto scaling capacity settings for a table in provisioned capacity mode.
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` `\|` `IResolvable` `\|` `ColumnProperty[]`	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.
replicaSpecifications?	`IResolvable` `\|` `IResolvable` `\|` `ReplicaSpecificationProperty[]`	The AWS Region specific settings of a multi-Region table.
tableName?	`string`	The name of the table to be created.
tags?	`CfnTag[]`	An array of key-value pairs to apply to this resource.

keyspaceName

Type: string

The name of the keyspace to create the table in.

The keyspace must already exist.

partitionKeyColumns

Type: IResolvable | IResolvable | ColumnProperty[]

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

Every table must have a partition key.

autoScalingSpecifications?

Type: IResolvable | AutoScalingSpecificationProperty (optional)

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

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 | IResolvable | ColumnProperty[] (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.

replicaSpecifications?

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

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

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?

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)

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

For more information, see Tag .

Properties

Name	Type	Description
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
keyspaceName	`string`	The name of the keyspace to create the table in.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
partitionKeyColumns	`IResolvable` `\|` `IResolvable` `\|` `ColumnProperty[]`	One or more columns that uniquely identify every row in the table.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
autoScalingSpecifications?	`IResolvable` `\|` `AutoScalingSpecificationProperty`	The optional auto scaling capacity settings for a table in provisioned capacity mode.
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` `\|` `IResolvable` `\|` `ColumnProperty[]`	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.
replicaSpecifications?	`IResolvable` `\|` `IResolvable` `\|` `ReplicaSpecificationProperty[]`	The AWS Region specific settings of a multi-Region table.
tableName?	`string`	The name of the table to be created.
tagsRaw?	`CfnTag[]`	An array of key-value pairs to apply to this resource.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

keyspaceName

Type: string

The name of the keyspace to create the table in.

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

partitionKeyColumns

Type: IResolvable | IResolvable | ColumnProperty[]

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

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

autoScalingSpecifications?

Type: IResolvable | AutoScalingSpecificationProperty (optional)

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

billingMode?

Type: IResolvable | BillingModeProperty (optional)

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

clientSideTimestampsEnabled?

Type: boolean | IResolvable (optional)

Enables client-side timestamps for the table.

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.

encryptionSpecification?

Type: IResolvable | EncryptionSpecificationProperty (optional)

The encryption at rest options for the table.

pointInTimeRecoveryEnabled?

Type: boolean | IResolvable (optional)

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

regularColumns?

Type: IResolvable | IResolvable | ColumnProperty[] (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.

replicaSpecifications?

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

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

tableName?

Type: string (optional)

The name of the table to be created.

tagsRaw?

Type: CfnTag[] (optional)

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

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }