LocalSecondaryIndexProps

class aws_cdk.aws_dynamodb.LocalSecondaryIndexProps(*, index_name, non_key_attributes=None, projection_type=None, sort_key)

Bases: aws_cdk.aws_dynamodb.SecondaryIndexProps

Properties for a local secondary index.

Parameters
  • index_name (str) – The name of the secondary index.

  • non_key_attributes (Optional[List[str]]) – The non-key attributes that are projected into the secondary index. Default: - No additional attributes

  • projection_type (Optional[ProjectionType]) – The set of attributes that are projected into the secondary index. Default: ALL

  • sort_key (Attribute) – The attribute of a sort key for the local secondary index.

Attributes

index_name

The name of the secondary index.

Return type

str

non_key_attributes

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

Default
  • No additional attributes

Return type

Optional[List[str]]

projection_type

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

Default

ALL

Return type

Optional[ProjectionType]

sort_key

The attribute of a sort key for the local secondary index.

Return type

Attribute