Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

Documentation

data PipeSourceManagedStreamingKafkaParameters

The parameters for using an MSK stream as a source.

See: newPipeSourceManagedStreamingKafkaParameters smart constructor.

Constructors

PipeSourceManagedStreamingKafkaParameters'

Fields

• batchSize :: Maybe Natural

  The maximum number of records to include in each batch.

• consumerGroupID :: Maybe (Sensitive Text)

  The name of the destination queue to consume.

• credentials :: Maybe MSKAccessCredentials

  The credentials needed to access the resource.

• maximumBatchingWindowInSeconds :: Maybe Natural

  The maximum length of a time to wait for events.

• startingPosition :: Maybe MSKStartPosition

  (Streams only) The position in a stream from which to start reading.

• topicName :: Sensitive Text

  The name of the topic that the pipe will read from.

Instances

FromJSON PipeSourceManagedStreamingKafkaParameters

Defined in Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

Methods

parseJSON :: Value -> Parser PipeSourceManagedStreamingKafkaParameters

parseJSONList :: Value -> Parser [PipeSourceManagedStreamingKafkaParameters]

ToJSON PipeSourceManagedStreamingKafkaParameters

Defined in Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

Methods

toJSON :: PipeSourceManagedStreamingKafkaParameters -> Value

toEncoding :: PipeSourceManagedStreamingKafkaParameters -> Encoding

toJSONList :: [PipeSourceManagedStreamingKafkaParameters] -> Value

toEncodingList :: [PipeSourceManagedStreamingKafkaParameters] -> Encoding

Generic PipeSourceManagedStreamingKafkaParameters

Defined in Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

Associated Types

type Rep PipeSourceManagedStreamingKafkaParameters :: Type -> Type

Methods

from :: PipeSourceManagedStreamingKafkaParameters -> Rep PipeSourceManagedStreamingKafkaParameters x

to :: Rep PipeSourceManagedStreamingKafkaParameters x -> PipeSourceManagedStreamingKafkaParameters

Show PipeSourceManagedStreamingKafkaParameters

Defined in Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

Methods

showsPrec :: Int -> PipeSourceManagedStreamingKafkaParameters -> ShowS

show :: PipeSourceManagedStreamingKafkaParameters -> String

showList :: [PipeSourceManagedStreamingKafkaParameters] -> ShowS

NFData PipeSourceManagedStreamingKafkaParameters

Defined in Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

Methods

rnf :: PipeSourceManagedStreamingKafkaParameters -> ()

Eq PipeSourceManagedStreamingKafkaParameters

Defined in Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

Methods

(==) :: PipeSourceManagedStreamingKafkaParameters -> PipeSourceManagedStreamingKafkaParameters -> Bool

(/=) :: PipeSourceManagedStreamingKafkaParameters -> PipeSourceManagedStreamingKafkaParameters -> Bool

Hashable PipeSourceManagedStreamingKafkaParameters

Defined in Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

Methods

hashWithSalt :: Int -> PipeSourceManagedStreamingKafkaParameters -> Int

hash :: PipeSourceManagedStreamingKafkaParameters -> Int

type Rep PipeSourceManagedStreamingKafkaParameters

Defined in Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

type Rep PipeSourceManagedStreamingKafkaParameters = D1 ('MetaData "PipeSourceManagedStreamingKafkaParameters" "Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "PipeSourceManagedStreamingKafkaParameters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "batchSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "consumerGroupID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MSKAccessCredentials)))) :*: (S1 ('MetaSel ('Just "maximumBatchingWindowInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "startingPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MSKStartPosition)) :*: S1 ('MetaSel ('Just "topicName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))

newPipeSourceManagedStreamingKafkaParameters

Arguments

:: Text

$sel:topicName:PipeSourceManagedStreamingKafkaParameters'

-> PipeSourceManagedStreamingKafkaParameters

Create a value of PipeSourceManagedStreamingKafkaParameters 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:batchSize:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_batchSize - The maximum number of records to include in each batch.

$sel:consumerGroupID:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_consumerGroupID - The name of the destination queue to consume.

$sel:credentials:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_credentials - The credentials needed to access the resource.

$sel:maximumBatchingWindowInSeconds:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.

$sel:startingPosition:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_startingPosition - (Streams only) The position in a stream from which to start reading.

$sel:topicName:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_topicName - The name of the topic that the pipe will read from.

pipeSourceManagedStreamingKafkaParameters_batchSize :: Lens' PipeSourceManagedStreamingKafkaParameters (Maybe Natural)

The maximum number of records to include in each batch.

pipeSourceManagedStreamingKafkaParameters_consumerGroupID :: Lens' PipeSourceManagedStreamingKafkaParameters (Maybe Text)

The name of the destination queue to consume.

pipeSourceManagedStreamingKafkaParameters_credentials :: Lens' PipeSourceManagedStreamingKafkaParameters (Maybe MSKAccessCredentials)

The credentials needed to access the resource.

pipeSourceManagedStreamingKafkaParameters_maximumBatchingWindowInSeconds :: Lens' PipeSourceManagedStreamingKafkaParameters (Maybe Natural)

The maximum length of a time to wait for events.

pipeSourceManagedStreamingKafkaParameters_startingPosition :: Lens' PipeSourceManagedStreamingKafkaParameters (Maybe MSKStartPosition)

(Streams only) The position in a stream from which to start reading.

pipeSourceManagedStreamingKafkaParameters_topicName :: Lens' PipeSourceManagedStreamingKafkaParameters Text

The name of the topic that the pipe will read from.