Package software.amazon.awscdk.services.dynamodb

Interface SchemaOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

GlobalSecondaryIndexProps, TableOptions, TableProps

All Known Implementing Classes:

GlobalSecondaryIndexProps.Jsii$Proxy, SchemaOptions.Jsii$Proxy, TableOptions.Jsii$Proxy, TableProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:08.536Z")
@Stability(Stable)
public interface SchemaOptions
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.dynamodb.*;
 SchemaOptions schemaOptions = SchemaOptions.builder()
         .partitionKey(Attribute.builder()
                 .name("name")
                 .type(AttributeType.BINARY)
                 .build())
         .sortKey(Attribute.builder()
                 .name("name")
                 .type(AttributeType.BINARY)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SchemaOptions.Builder	A builder for SchemaOptions
static final class	SchemaOptions.Jsii$Proxy	An implementation for SchemaOptions

Method Summary

Modifier and Type	Method	Description
static SchemaOptions.Builder	builder()
default Attribute	getPartitionKey()	Partition key attribute definition.
default Attribute	getSortKey()	Sort key attribute definition.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPartitionKey

@Stability(Stable)
@Nullable
default Attribute getPartitionKey()

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

Default: - exactly one of `partitionKey` and `partitionKeys` must be specified.

getSortKey

@Stability(Stable)
@Nullable
default Attribute getSortKey()

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

Default: - no sort key

builder

@Stability(Stable)
static SchemaOptions.Builder builder()

Returns:

a SchemaOptions.Builder of SchemaOptions