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.98.0 (build 00b106d)",
           date="2024-05-08T21:35:05.560Z")
@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())
         // the properties below are optional
         .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()
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)
@NotNull
Attribute getPartitionKey()

Partition key attribute definition.

getSortKey

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

Sort key attribute definition.

Default: no sort key

builder

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

Returns:

a SchemaOptions.Builder of SchemaOptions