GlobalSecondaryIndexProps

class aws_cdk.aws_dynamodb.GlobalSecondaryIndexProps(*, index_name, non_key_attributes=None, projection_type=None, partition_key, read_capacity=None, sort_key=None, write_capacity=None)

Bases: aws_cdk.aws_dynamodb.SecondaryIndexProps

Properties for a global 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

  • partition_key (Attribute) – The attribute of a partition key for the global secondary index.

  • read_capacity (Union[int, float, None]) – The read capacity for the global secondary index. Can only be provided if table billingMode is Provisioned or undefined. Default: 5

  • sort_key (Optional[Attribute]) – The attribute of a sort key for the global secondary index. Default: - No sort key

  • write_capacity (Union[int, float, None]) – The write capacity for the global secondary index. Can only be provided if table billingMode is Provisioned or undefined. Default: 5

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]]

partition_key

The attribute of a partition key for the global secondary index.

Return type

Attribute

projection_type

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

Default

ALL

Return type

Optional[ProjectionType]

read_capacity

The read capacity for the global secondary index.

Can only be provided if table billingMode is Provisioned or undefined.

Default

5

Return type

Union[int, float, None]

sort_key

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

Default
  • No sort key

Return type

Optional[Attribute]

write_capacity

The write capacity for the global secondary index.

Can only be provided if table billingMode is Provisioned or undefined.

Default

5

Return type

Union[int, float, None]