You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DynamoDB::Types::Projection

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Projection as input to an Aws::Client method, you can use a vanilla Hash:

{
  projection_type: "ALL", # accepts ALL, KEYS_ONLY, INCLUDE
  non_key_attributes: ["NonKeyAttributeName"],
}

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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#non_key_attributesArray<String>

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 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

Returns:

  • (Array<String>)

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

#projection_typeString

The set of attributes that are projected into the index:

  • KEYS_ONLY - Only the index and primary keys are projected into the index.

  • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

  • ALL - All of the table attributes are projected into the index.

    Possible values:

    • ALL
    • KEYS_ONLY
    • INCLUDE

Returns:

  • (String)

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