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.Pipes.Types.PipeTargetKinesisStreamParameters

Description

Synopsis

data PipeTargetKinesisStreamParameters = PipeTargetKinesisStreamParameters' {
- partitionKey :: Sensitive Text
}
newPipeTargetKinesisStreamParameters :: Text -> PipeTargetKinesisStreamParameters
pipeTargetKinesisStreamParameters_partitionKey :: Lens' PipeTargetKinesisStreamParameters Text

Documentation

data PipeTargetKinesisStreamParameters Source #

The parameters for using a Kinesis stream as a source.

See: newPipeTargetKinesisStreamParameters smart constructor.

Constructors

PipeTargetKinesisStreamParameters'

Fields

partitionKey :: Sensitive Text
Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

Instances

Instances details

FromJSON PipeTargetKinesisStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetKinesisStreamParameters Methods parseJSON :: Value -> Parser PipeTargetKinesisStreamParameters # parseJSONList :: Value -> Parser [PipeTargetKinesisStreamParameters] #
ToJSON PipeTargetKinesisStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetKinesisStreamParameters Methods toJSON :: PipeTargetKinesisStreamParameters -> Value # toEncoding :: PipeTargetKinesisStreamParameters -> Encoding # toJSONList :: [PipeTargetKinesisStreamParameters] -> Value # toEncodingList :: [PipeTargetKinesisStreamParameters] -> Encoding #
Generic PipeTargetKinesisStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetKinesisStreamParameters Associated Types type Rep PipeTargetKinesisStreamParameters :: Type -> Type # Methods from :: PipeTargetKinesisStreamParameters -> Rep PipeTargetKinesisStreamParameters x # to :: Rep PipeTargetKinesisStreamParameters x -> PipeTargetKinesisStreamParameters #
Show PipeTargetKinesisStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetKinesisStreamParameters Methods showsPrec :: Int -> PipeTargetKinesisStreamParameters -> ShowS # show :: PipeTargetKinesisStreamParameters -> String # showList :: [PipeTargetKinesisStreamParameters] -> ShowS #
NFData PipeTargetKinesisStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetKinesisStreamParameters Methods rnf :: PipeTargetKinesisStreamParameters -> () #
Eq PipeTargetKinesisStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetKinesisStreamParameters Methods (==) :: PipeTargetKinesisStreamParameters -> PipeTargetKinesisStreamParameters -> Bool # (/=) :: PipeTargetKinesisStreamParameters -> PipeTargetKinesisStreamParameters -> Bool #
Hashable PipeTargetKinesisStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetKinesisStreamParameters Methods hashWithSalt :: Int -> PipeTargetKinesisStreamParameters -> Int # hash :: PipeTargetKinesisStreamParameters -> Int #
type Rep PipeTargetKinesisStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetKinesisStreamParameters type Rep PipeTargetKinesisStreamParameters = D1 ('MetaData "PipeTargetKinesisStreamParameters" "Amazonka.Pipes.Types.PipeTargetKinesisStreamParameters" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "PipeTargetKinesisStreamParameters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "partitionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))

newPipeTargetKinesisStreamParameters Source #

Arguments

:: Text	`$sel:partitionKey:PipeTargetKinesisStreamParameters'`
-> PipeTargetKinesisStreamParameters

Create a value of PipeTargetKinesisStreamParameters 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:partitionKey:PipeTargetKinesisStreamParameters', pipeTargetKinesisStreamParameters_partitionKey - Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

pipeTargetKinesisStreamParameters_partitionKey :: Lens' PipeTargetKinesisStreamParameters Text Source #

Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.