aws-cdk-lib.aws_dynamodb.CfnTable.ProjectionProperty

interface ProjectionProperty

LanguageType name
.NETAmazon.CDK.AWS.DynamoDB.CfnTable.ProjectionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdynamodb#CfnTable_ProjectionProperty
Javasoftware.amazon.awscdk.services.dynamodb.CfnTable.ProjectionProperty
Pythonaws_cdk.aws_dynamodb.CfnTable.ProjectionProperty
TypeScript aws-cdk-lib » aws_dynamodb » CfnTable » ProjectionProperty

Represents attributes that are copied (projected) from the table into an index.

These are in addition to the primary key attributes and index key attributes, which are automatically projected.

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 projectionProperty: dynamodb.CfnTable.ProjectionProperty = {
  nonKeyAttributes: ['nonKeyAttributes'],
  projectionType: 'projectionType',
};

Properties

NameTypeDescription
nonKeyAttributes?string[]Represents the non-key attribute names which will be projected into the index.
projectionType?stringThe set of attributes that are projected into the index:.

nonKeyAttributes?

Type: string[] (optional)

Represents the non-key attribute names which will be projected into the index.

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.


projectionType?

Type: string (optional)

The set of attributes that are projected into the index:.

  • KEYS_ONLY - Only the index and primary keys are projected into the index.
  • INCLUDE - In addition to the attributes described in KEYS_ONLY , the secondary index will include other non-key attributes that you specify.
  • ALL - All of the table attributes are projected into the index.