Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DynamoDB.Types.Projection

Description

Synopsis

Documentation

data Projection Source #

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.

See: newProjection smart constructor.

Constructors

Projection'

Fields

projectionType :: Maybe ProjectionType
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.
nonKeyAttributes :: Maybe (NonEmpty Text)
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.

Instances

Instances details

Eq Projection Source #
Instance details Defined in Amazonka.DynamoDB.Types.Projection Methods (==) :: Projection -> Projection -> Bool # (/=) :: Projection -> Projection -> Bool #
Read Projection Source #
Instance details Defined in Amazonka.DynamoDB.Types.Projection Methods readsPrec :: Int -> ReadS Projection # readList :: ReadS [Projection] # readPrec :: ReadPrec Projection # readListPrec :: ReadPrec [Projection] #
Show Projection Source #
Instance details Defined in Amazonka.DynamoDB.Types.Projection Methods showsPrec :: Int -> Projection -> ShowS # show :: Projection -> String # showList :: [Projection] -> ShowS #
Generic Projection Source #
Instance details Defined in Amazonka.DynamoDB.Types.Projection Associated Types type Rep Projection :: Type -> Type # Methods from :: Projection -> Rep Projection x # to :: Rep Projection x -> Projection #
NFData Projection Source #
Instance details Defined in Amazonka.DynamoDB.Types.Projection Methods rnf :: Projection -> () #
Hashable Projection Source #
Instance details Defined in Amazonka.DynamoDB.Types.Projection Methods hashWithSalt :: Int -> Projection -> Int # hash :: Projection -> Int #
ToJSON Projection Source #
Instance details Defined in Amazonka.DynamoDB.Types.Projection Methods toJSON :: Projection -> Value # toEncoding :: Projection -> Encoding # toJSONList :: [Projection] -> Value # toEncodingList :: [Projection] -> Encoding #
FromJSON Projection Source #
Instance details Defined in Amazonka.DynamoDB.Types.Projection Methods parseJSON :: Value -> Parser Projection # parseJSONList :: Value -> Parser [Projection] #
type Rep Projection Source #
Instance details Defined in Amazonka.DynamoDB.Types.Projection type Rep Projection = D1 ('MetaData "Projection" "Amazonka.DynamoDB.Types.Projection" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "Projection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "projectionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProjectionType)) :*: S1 ('MetaSel ('Just "nonKeyAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))))

newProjection :: Projection Source #

Create a value of Projection with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:projectionType:Projection', projection_projectionType - 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.

$sel:nonKeyAttributes:Projection', projection_nonKeyAttributes - 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.

projection_projectionType :: Lens' Projection (Maybe ProjectionType) Source #

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.

projection_nonKeyAttributes :: Lens' Projection (Maybe (NonEmpty Text)) Source #

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.