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.PipeSourceSelfManagedKafkaParameters

Description

Synopsis

Documentation

data PipeSourceSelfManagedKafkaParameters Source #

The parameters for using a self-managed Apache Kafka stream as a source.

See: newPipeSourceSelfManagedKafkaParameters smart constructor.

Constructors

PipeSourceSelfManagedKafkaParameters'

Fields

additionalBootstrapServers :: Maybe [Sensitive Text]
An array of server URLs.
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 SelfManagedKafkaAccessConfigurationCredentials
The credentials needed to access the resource.
maximumBatchingWindowInSeconds :: Maybe Natural
The maximum length of a time to wait for events.
serverRootCaCertificate :: Maybe Text
The ARN of the Secrets Manager secret used for certification.
startingPosition :: Maybe SelfManagedKafkaStartPosition
(Streams only) The position in a stream from which to start reading.
vpc :: Maybe SelfManagedKafkaAccessConfigurationVpc
This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
topicName :: Sensitive Text
The name of the topic that the pipe will read from.

Instances

Instances details

FromJSON PipeSourceSelfManagedKafkaParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceSelfManagedKafkaParameters Methods parseJSON :: Value -> Parser PipeSourceSelfManagedKafkaParameters # parseJSONList :: Value -> Parser [PipeSourceSelfManagedKafkaParameters] #
ToJSON PipeSourceSelfManagedKafkaParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceSelfManagedKafkaParameters Methods toJSON :: PipeSourceSelfManagedKafkaParameters -> Value # toEncoding :: PipeSourceSelfManagedKafkaParameters -> Encoding # toJSONList :: [PipeSourceSelfManagedKafkaParameters] -> Value # toEncodingList :: [PipeSourceSelfManagedKafkaParameters] -> Encoding #
Generic PipeSourceSelfManagedKafkaParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceSelfManagedKafkaParameters Associated Types type Rep PipeSourceSelfManagedKafkaParameters :: Type -> Type # Methods from :: PipeSourceSelfManagedKafkaParameters -> Rep PipeSourceSelfManagedKafkaParameters x # to :: Rep PipeSourceSelfManagedKafkaParameters x -> PipeSourceSelfManagedKafkaParameters #
Show PipeSourceSelfManagedKafkaParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceSelfManagedKafkaParameters Methods showsPrec :: Int -> PipeSourceSelfManagedKafkaParameters -> ShowS # show :: PipeSourceSelfManagedKafkaParameters -> String # showList :: [PipeSourceSelfManagedKafkaParameters] -> ShowS #
NFData PipeSourceSelfManagedKafkaParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceSelfManagedKafkaParameters Methods rnf :: PipeSourceSelfManagedKafkaParameters -> () #
Eq PipeSourceSelfManagedKafkaParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceSelfManagedKafkaParameters Methods (==) :: PipeSourceSelfManagedKafkaParameters -> PipeSourceSelfManagedKafkaParameters -> Bool # (/=) :: PipeSourceSelfManagedKafkaParameters -> PipeSourceSelfManagedKafkaParameters -> Bool #
Hashable PipeSourceSelfManagedKafkaParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceSelfManagedKafkaParameters Methods hashWithSalt :: Int -> PipeSourceSelfManagedKafkaParameters -> Int # hash :: PipeSourceSelfManagedKafkaParameters -> Int #
type Rep PipeSourceSelfManagedKafkaParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceSelfManagedKafkaParameters type Rep PipeSourceSelfManagedKafkaParameters = D1 ('MetaData "PipeSourceSelfManagedKafkaParameters" "Amazonka.Pipes.Types.PipeSourceSelfManagedKafkaParameters" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "PipeSourceSelfManagedKafkaParameters'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "additionalBootstrapServers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Sensitive Text])) :: 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 SelfManagedKafkaAccessConfigurationCredentials)))) :: ((S1 ('MetaSel ('Just "maximumBatchingWindowInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "serverRootCaCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "startingPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SelfManagedKafkaStartPosition)) :: (S1 ('MetaSel ('Just "vpc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SelfManagedKafkaAccessConfigurationVpc)) :: S1 ('MetaSel ('Just "topicName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))))

newPipeSourceSelfManagedKafkaParameters Source #

Arguments

:: Text	`$sel:topicName:PipeSourceSelfManagedKafkaParameters'`
-> PipeSourceSelfManagedKafkaParameters

Create a value of PipeSourceSelfManagedKafkaParameters 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:additionalBootstrapServers:PipeSourceSelfManagedKafkaParameters', pipeSourceSelfManagedKafkaParameters_additionalBootstrapServers - An array of server URLs.

$sel:batchSize:PipeSourceSelfManagedKafkaParameters', pipeSourceSelfManagedKafkaParameters_batchSize - The maximum number of records to include in each batch.

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

$sel:credentials:PipeSourceSelfManagedKafkaParameters', pipeSourceSelfManagedKafkaParameters_credentials - The credentials needed to access the resource.

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

$sel:serverRootCaCertificate:PipeSourceSelfManagedKafkaParameters', pipeSourceSelfManagedKafkaParameters_serverRootCaCertificate - The ARN of the Secrets Manager secret used for certification.

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

$sel:vpc:PipeSourceSelfManagedKafkaParameters', pipeSourceSelfManagedKafkaParameters_vpc - This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

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

pipeSourceSelfManagedKafkaParameters_additionalBootstrapServers :: Lens' PipeSourceSelfManagedKafkaParameters (Maybe [Text]) Source #

An array of server URLs.

pipeSourceSelfManagedKafkaParameters_batchSize :: Lens' PipeSourceSelfManagedKafkaParameters (Maybe Natural) Source #

The maximum number of records to include in each batch.

pipeSourceSelfManagedKafkaParameters_consumerGroupID :: Lens' PipeSourceSelfManagedKafkaParameters (Maybe Text) Source #

The name of the destination queue to consume.

pipeSourceSelfManagedKafkaParameters_credentials :: Lens' PipeSourceSelfManagedKafkaParameters (Maybe SelfManagedKafkaAccessConfigurationCredentials) Source #

The credentials needed to access the resource.

pipeSourceSelfManagedKafkaParameters_maximumBatchingWindowInSeconds :: Lens' PipeSourceSelfManagedKafkaParameters (Maybe Natural) Source #

The maximum length of a time to wait for events.

pipeSourceSelfManagedKafkaParameters_serverRootCaCertificate :: Lens' PipeSourceSelfManagedKafkaParameters (Maybe Text) Source #

The ARN of the Secrets Manager secret used for certification.

pipeSourceSelfManagedKafkaParameters_startingPosition :: Lens' PipeSourceSelfManagedKafkaParameters (Maybe SelfManagedKafkaStartPosition) Source #

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

pipeSourceSelfManagedKafkaParameters_vpc :: Lens' PipeSourceSelfManagedKafkaParameters (Maybe SelfManagedKafkaAccessConfigurationVpc) Source #

This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

pipeSourceSelfManagedKafkaParameters_topicName :: Lens' PipeSourceSelfManagedKafkaParameters Text Source #

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