KeySchemaProperty Struct
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.
| Source | |
|---|---|
| Type last changed |
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 keySchemaProperty: dynamodb.CfnTable.KeySchemaProperty = {
attributeName: 'attributeName',
keyType: 'keyType',
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_dynamodb as dynamodb
key_schema_property = dynamodb.CfnTable.KeySchemaProperty(
attribute_name="attributeName",
key_type="keyType"
)
// 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();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DynamoDB;
var keySchemaProperty = new KeySchemaProperty {
AttributeName = "attributeName",
KeyType = "keyType"
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
keySchemaProperty := &KeySchemaProperty{
AttributeName: jsii.String("attributeName"),
KeyType: jsii.String("keyType"),
}
Properties
attributeNamestringattribute_namestrattributeNameStringAttributeNamestringAttributeName*string required #notes
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.