Package software.amazon.awscdk.services.dynamodb

Interface CfnTable.KeySchemaProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTable.KeySchemaProperty.Jsii$Proxy

Enclosing class:

CfnTable

@Stability(Stable)
public static interface CfnTable.KeySchemaProperty
extends software.amazon.jsii.JsiiSerializable

Represents a single element of a key schema.

A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.

A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.

A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.

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.*;
 KeySchemaProperty keySchemaProperty = KeySchemaProperty.builder()
         .attributeName("attributeName")
         .keyType("keyType")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTable.KeySchemaProperty.Builder	builder()
String	getAttributeName()	The name of a key attribute.
String	getKeyType()	The role that this key attribute will assume:.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAttributeName

@Stability(Stable)
@NotNull
String getAttributeName()

The name of a key attribute.

getKeyType

@Stability(Stable)
@NotNull
String getKeyType()

The role that this key attribute will assume:.

• HASH - partition key
• RANGE - sort key

The partition key of an item is also known as its hash attribute . The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

builder

@Stability(Stable)
static CfnTable.KeySchemaProperty.Builder builder()

Returns:

a CfnTable.KeySchemaProperty.Builder of CfnTable.KeySchemaProperty