interface LocalSecondaryIndexProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.DynamoDB.LocalSecondaryIndexProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsdynamodb#LocalSecondaryIndexProps |
Java | software.amazon.awscdk.services.dynamodb.LocalSecondaryIndexProps |
Python | aws_cdk.aws_dynamodb.LocalSecondaryIndexProps |
TypeScript (source) | aws-cdk-lib » aws_dynamodb » LocalSecondaryIndexProps |
Properties for a local secondary index.
Example
const table = new dynamodb.TableV2(this, 'Table', {
partitionKey: { name: 'pk', type: dynamodb.AttributeType.STRING },
sortKey: { name: 'sk', type: dynamodb.AttributeType.NUMBER },
localSecondaryIndexes: [
{
indexName: 'lsi1',
sortKey: { name: 'sk', type: dynamodb.AttributeType.NUMBER },
},
],
});
table.addLocalSecondaryIndex({
indexName: 'lsi2',
sortKey: { name: 'sk', type: dynamodb.AttributeType.NUMBER },
});
Properties
Name | Type | Description |
---|---|---|
index | string | The name of the secondary index. |
sort | Attribute | The attribute of a sort key for the local secondary index. |
non | string[] | The non-key attributes that are projected into the secondary index. |
projection | Projection | The set of attributes that are projected into the secondary index. |
indexName
Type:
string
The name of the secondary index.
sortKey
Type:
Attribute
The attribute of a sort key for the local secondary index.
nonKeyAttributes?
Type:
string[]
(optional, default: No additional attributes)
The non-key attributes that are projected into the secondary index.
projectionType?
Type:
Projection
(optional, default: ALL)
The set of attributes that are projected into the secondary index.