Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudWatchEvents.Types.KinesisParameters

Description

Synopsis

data KinesisParameters = KinesisParameters' {
- partitionKeyPath :: Text
}
newKinesisParameters :: Text -> KinesisParameters
kinesisParameters_partitionKeyPath :: Lens' KinesisParameters Text

Documentation

data KinesisParameters Source #

This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream, so that you can control the shard to which the event goes. If you do not include this parameter, the default is to use the eventId as the partition key.

See: newKinesisParameters smart constructor.

Constructors

KinesisParameters'
Fields partitionKeyPath :: Text The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

Instances

Instances details

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

newKinesisParameters Source #

Arguments

:: Text	`$sel:partitionKeyPath:KinesisParameters'`
-> KinesisParameters

Create a value of KinesisParameters 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:partitionKeyPath:KinesisParameters', kinesisParameters_partitionKeyPath - The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

kinesisParameters_partitionKeyPath :: Lens' KinesisParameters Text Source #

The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.