aws-cdk-lib.aws_dynamodb.SecondaryIndexProps

SecondaryIndexProps Struct

Properties for a secondary index.

Source

aws-dynamodb/lib/shared.ts

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 secondaryIndexProps: dynamodb.SecondaryIndexProps = {
  indexName: 'indexName',

  // the properties below are optional
  nonKeyAttributes: ['nonKeyAttributes'],
  projectionType: dynamodb.ProjectionType.KEYS_ONLY,
};

Properties

indexNamestringindex_namestrindexNameStringIndexNamestringIndexName*stringrequired#

The name of the secondary index.

nonKeyAttributes?optionalstring[]non_key_attributes?optionaltyping.List[str]nonKeyAttributes?optionalList<String>NonKeyAttributes?optionalstring[]NonKeyAttributes?optional*[]*string#

The non-key attributes that are projected into the secondary index.

Default: No additional attributes

projectionType?optionalProjectionTypeprojection_type?optionalProjectionTypeprojectionType?optionalProjectionTypeProjectionType?optionalProjectionTypeProjectionType?optionalProjectionType= ALL#

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