interface SchemaOptions

Language	Type name
.NET	Amazon.CDK.AWS.DynamoDB.SchemaOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdynamodb#SchemaOptions
Java	software.amazon.awscdk.services.dynamodb.SchemaOptions
Python	aws_cdk.aws_dynamodb.SchemaOptions
TypeScript (source)	aws-cdk-lib » aws_dynamodb » SchemaOptions

Obtainable from Table.schema()

Represents the table schema attributes.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dynamodb as dynamodb } from 'aws-cdk-lib';
const schemaOptions: dynamodb.SchemaOptions = {
  partitionKey: {
    name: 'name',
    type: dynamodb.AttributeType.BINARY,
  },
  sortKey: {
    name: 'name',
    type: dynamodb.AttributeType.BINARY,
  },
};

Properties

Name	Type	Description
partitionKey?	Attribute	Partition key attribute definition.
sortKey?	Attribute	Sort key attribute definition.

---

partitionKey?

Type: Attribute (optional, default: exactly one of partitionKey and partitionKeys must be specified.)

Partition key attribute definition.

If a single field forms the partition key, you can use this field. Use the partitionKeys field if the partition key is a multi-attribute key (consists of multiple fields).

---

sortKey?

Type: Attribute (optional, default: no sort key)

Sort key attribute definition.

If a single field forms the sort key, you can use this field. Use the sortKeys field if the sort key is a multi-attribute key (consists of multiple fields).