interface KeySchemaProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.DynamoDB.CfnGlobalTable.KeySchemaProperty |
Java | software.amazon.awscdk.services.dynamodb.CfnGlobalTable.KeySchemaProperty |
Python | aws_cdk.aws_dynamodb.CfnGlobalTable.KeySchemaProperty |
TypeScript | @aws-cdk/aws-dynamodb » CfnGlobalTable » KeySchemaProperty |
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 * as dynamodb from '@aws-cdk/aws-dynamodb';
const keySchemaProperty: dynamodb.CfnGlobalTable.KeySchemaProperty = {
attributeName: 'attributeName',
keyType: 'keyType',
};
Properties
Name | Type | Description |
---|---|---|
attribute | string | The name of a key attribute. |
key | string | The role that this key attribute will assume:. |
attributeName
Type:
string
The name of a key attribute.
keyType
Type:
string
The role that this key attribute will assume:.
HASH
- partition keyRANGE
- 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.