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.KafkaConnect.CreateConnector

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a connector using the specified properties.

Synopsis

data CreateConnector = CreateConnector' {
- logDelivery :: Maybe LogDelivery
- workerConfiguration :: Maybe WorkerConfiguration
- connectorDescription :: Maybe Text
- capacity :: Capacity
- connectorConfiguration :: HashMap Text Text
- connectorName :: Text
- kafkaCluster :: KafkaCluster
- kafkaClusterClientAuthentication :: KafkaClusterClientAuthentication
- kafkaClusterEncryptionInTransit :: KafkaClusterEncryptionInTransit
- kafkaConnectVersion :: Text
- plugins :: [Plugin]
- serviceExecutionRoleArn :: Text
}
newCreateConnector :: Capacity -> Text -> KafkaCluster -> KafkaClusterClientAuthentication -> KafkaClusterEncryptionInTransit -> Text -> Text -> CreateConnector
createConnector_logDelivery :: Lens' CreateConnector (Maybe LogDelivery)
createConnector_workerConfiguration :: Lens' CreateConnector (Maybe WorkerConfiguration)
createConnector_connectorDescription :: Lens' CreateConnector (Maybe Text)
createConnector_capacity :: Lens' CreateConnector Capacity
createConnector_connectorConfiguration :: Lens' CreateConnector (HashMap Text Text)
createConnector_connectorName :: Lens' CreateConnector Text
createConnector_kafkaCluster :: Lens' CreateConnector KafkaCluster
createConnector_kafkaClusterClientAuthentication :: Lens' CreateConnector KafkaClusterClientAuthentication
createConnector_kafkaClusterEncryptionInTransit :: Lens' CreateConnector KafkaClusterEncryptionInTransit
createConnector_kafkaConnectVersion :: Lens' CreateConnector Text
createConnector_plugins :: Lens' CreateConnector [Plugin]
createConnector_serviceExecutionRoleArn :: Lens' CreateConnector Text
data CreateConnectorResponse = CreateConnectorResponse' {
- connectorArn :: Maybe Text
- connectorName :: Maybe Text
- connectorState :: Maybe ConnectorState
- httpStatus :: Int
}
newCreateConnectorResponse :: Int -> CreateConnectorResponse
createConnectorResponse_connectorArn :: Lens' CreateConnectorResponse (Maybe Text)
createConnectorResponse_connectorName :: Lens' CreateConnectorResponse (Maybe Text)
createConnectorResponse_connectorState :: Lens' CreateConnectorResponse (Maybe ConnectorState)
createConnectorResponse_httpStatus :: Lens' CreateConnectorResponse Int

Creating a Request

data CreateConnector Source #

See: newCreateConnector smart constructor.

Constructors

CreateConnector'

Fields

logDelivery :: Maybe LogDelivery
Details about log delivery.
workerConfiguration :: Maybe WorkerConfiguration
Specifies which worker configuration to use with the connector.
connectorDescription :: Maybe Text
A summary description of the connector.
capacity :: Capacity
Information about the capacity allocated to the connector. Exactly one of the two properties must be specified.
connectorConfiguration :: HashMap Text Text
A map of keys to values that represent the configuration for the connector.
connectorName :: Text
The name of the connector.
kafkaCluster :: KafkaCluster
Specifies which Apache Kafka cluster to connect to.
kafkaClusterClientAuthentication :: KafkaClusterClientAuthentication
Details of the client authentication used by the Apache Kafka cluster.
kafkaClusterEncryptionInTransit :: KafkaClusterEncryptionInTransit
Details of encryption in transit to the Apache Kafka cluster.
kafkaConnectVersion :: Text
The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.
plugins :: [Plugin]
Specifies which plugins to use for the connector.
serviceExecutionRoleArn :: Text
The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs. The types of resources depends on the logic of the connector. For example, a connector that has Amazon S3 as a destination must have permissions that allow it to write to the S3 destination bucket.

Instances

Instances details

Eq CreateConnector Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector Methods (==) :: CreateConnector -> CreateConnector -> Bool # (/=) :: CreateConnector -> CreateConnector -> Bool #
Read CreateConnector Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector Methods readsPrec :: Int -> ReadS CreateConnector # readList :: ReadS [CreateConnector] # readPrec :: ReadPrec CreateConnector # readListPrec :: ReadPrec [CreateConnector] #
Show CreateConnector Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector Methods showsPrec :: Int -> CreateConnector -> ShowS # show :: CreateConnector -> String # showList :: [CreateConnector] -> ShowS #
Generic CreateConnector Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector Associated Types type Rep CreateConnector :: Type -> Type # Methods from :: CreateConnector -> Rep CreateConnector x # to :: Rep CreateConnector x -> CreateConnector #
NFData CreateConnector Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector Methods rnf :: CreateConnector -> () #
Hashable CreateConnector Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector Methods hashWithSalt :: Int -> CreateConnector -> Int # hash :: CreateConnector -> Int #
ToJSON CreateConnector Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector Methods toJSON :: CreateConnector -> Value # toEncoding :: CreateConnector -> Encoding # toJSONList :: [CreateConnector] -> Value # toEncodingList :: [CreateConnector] -> Encoding #
AWSRequest CreateConnector Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector Associated Types type AWSResponse CreateConnector # Methods request :: CreateConnector -> Request CreateConnector # response :: MonadResource m => Logger -> Service -> Proxy CreateConnector -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateConnector))) #
ToHeaders CreateConnector Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector Methods toHeaders :: CreateConnector -> [Header] #
ToPath CreateConnector Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector Methods toPath :: CreateConnector -> ByteString #
ToQuery CreateConnector Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector Methods toQuery :: CreateConnector -> QueryString #
type Rep CreateConnector Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector type Rep CreateConnector = D1 ('MetaData "CreateConnector" "Amazonka.KafkaConnect.CreateConnector" "libZSservicesZSamazonka-kafkaconnectZSamazonka-kafkaconnect" 'False) (C1 ('MetaCons "CreateConnector'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "logDelivery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogDelivery)) :: (S1 ('MetaSel ('Just "workerConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkerConfiguration)) :: S1 ('MetaSel ('Just "connectorDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "capacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Capacity) :: (S1 ('MetaSel ('Just "connectorConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text)) :: S1 ('MetaSel ('Just "connectorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :: ((S1 ('MetaSel ('Just "kafkaCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 KafkaCluster) :: (S1 ('MetaSel ('Just "kafkaClusterClientAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 KafkaClusterClientAuthentication) :: S1 ('MetaSel ('Just "kafkaClusterEncryptionInTransit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 KafkaClusterEncryptionInTransit))) :: (S1 ('MetaSel ('Just "kafkaConnectVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "plugins") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Plugin]) :*: S1 ('MetaSel ('Just "serviceExecutionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateConnector Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector type AWSResponse CreateConnector = CreateConnectorResponse

newCreateConnector Source #

Arguments

:: Capacity	`$sel:capacity:CreateConnector'`
-> Text	`$sel:connectorName:CreateConnector'`
-> KafkaCluster	`$sel:kafkaCluster:CreateConnector'`
-> KafkaClusterClientAuthentication	`$sel:kafkaClusterClientAuthentication:CreateConnector'`
-> KafkaClusterEncryptionInTransit	`$sel:kafkaClusterEncryptionInTransit:CreateConnector'`
-> Text	`$sel:kafkaConnectVersion:CreateConnector'`
-> Text	`$sel:serviceExecutionRoleArn:CreateConnector'`
-> CreateConnector

Create a value of CreateConnector 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:logDelivery:CreateConnector', createConnector_logDelivery - Details about log delivery.

$sel:workerConfiguration:CreateConnector', createConnector_workerConfiguration - Specifies which worker configuration to use with the connector.

$sel:connectorDescription:CreateConnector', createConnector_connectorDescription - A summary description of the connector.

$sel:capacity:CreateConnector', createConnector_capacity - Information about the capacity allocated to the connector. Exactly one of the two properties must be specified.

$sel:connectorConfiguration:CreateConnector', createConnector_connectorConfiguration - A map of keys to values that represent the configuration for the connector.

$sel:connectorName:CreateConnector', createConnector_connectorName - The name of the connector.

$sel:kafkaCluster:CreateConnector', createConnector_kafkaCluster - Specifies which Apache Kafka cluster to connect to.

$sel:kafkaClusterClientAuthentication:CreateConnector', createConnector_kafkaClusterClientAuthentication - Details of the client authentication used by the Apache Kafka cluster.

$sel:kafkaClusterEncryptionInTransit:CreateConnector', createConnector_kafkaClusterEncryptionInTransit - Details of encryption in transit to the Apache Kafka cluster.

$sel:kafkaConnectVersion:CreateConnector', createConnector_kafkaConnectVersion - The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.

$sel:plugins:CreateConnector', createConnector_plugins - Specifies which plugins to use for the connector.

$sel:serviceExecutionRoleArn:CreateConnector', createConnector_serviceExecutionRoleArn - The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs. The types of resources depends on the logic of the connector. For example, a connector that has Amazon S3 as a destination must have permissions that allow it to write to the S3 destination bucket.

Request Lenses

createConnector_logDelivery :: Lens' CreateConnector (Maybe LogDelivery) Source #

Details about log delivery.

createConnector_workerConfiguration :: Lens' CreateConnector (Maybe WorkerConfiguration) Source #

Specifies which worker configuration to use with the connector.

createConnector_connectorDescription :: Lens' CreateConnector (Maybe Text) Source #

A summary description of the connector.

createConnector_capacity :: Lens' CreateConnector Capacity Source #

Information about the capacity allocated to the connector. Exactly one of the two properties must be specified.

createConnector_connectorConfiguration :: Lens' CreateConnector (HashMap Text Text) Source #

A map of keys to values that represent the configuration for the connector.

createConnector_connectorName :: Lens' CreateConnector Text Source #

The name of the connector.

createConnector_kafkaCluster :: Lens' CreateConnector KafkaCluster Source #

Specifies which Apache Kafka cluster to connect to.

createConnector_kafkaClusterClientAuthentication :: Lens' CreateConnector KafkaClusterClientAuthentication Source #

Details of the client authentication used by the Apache Kafka cluster.

createConnector_kafkaClusterEncryptionInTransit :: Lens' CreateConnector KafkaClusterEncryptionInTransit Source #

Details of encryption in transit to the Apache Kafka cluster.

createConnector_kafkaConnectVersion :: Lens' CreateConnector Text Source #

The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.

createConnector_plugins :: Lens' CreateConnector [Plugin] Source #

Specifies which plugins to use for the connector.

createConnector_serviceExecutionRoleArn :: Lens' CreateConnector Text Source #

The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs. The types of resources depends on the logic of the connector. For example, a connector that has Amazon S3 as a destination must have permissions that allow it to write to the S3 destination bucket.

Destructuring the Response

data CreateConnectorResponse Source #

See: newCreateConnectorResponse smart constructor.

Constructors

CreateConnectorResponse'
Fields connectorArn :: Maybe Text The Amazon Resource Name (ARN) that Amazon assigned to the connector. connectorName :: Maybe Text The name of the connector. connectorState :: Maybe ConnectorState The state of the connector. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateConnectorResponse Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector Methods (==) :: CreateConnectorResponse -> CreateConnectorResponse -> Bool # (/=) :: CreateConnectorResponse -> CreateConnectorResponse -> Bool #
Read CreateConnectorResponse Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector Methods readsPrec :: Int -> ReadS CreateConnectorResponse # readList :: ReadS [CreateConnectorResponse] # readPrec :: ReadPrec CreateConnectorResponse # readListPrec :: ReadPrec [CreateConnectorResponse] #
Show CreateConnectorResponse Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector Methods showsPrec :: Int -> CreateConnectorResponse -> ShowS # show :: CreateConnectorResponse -> String # showList :: [CreateConnectorResponse] -> ShowS #
Generic CreateConnectorResponse Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector Associated Types type Rep CreateConnectorResponse :: Type -> Type # Methods from :: CreateConnectorResponse -> Rep CreateConnectorResponse x # to :: Rep CreateConnectorResponse x -> CreateConnectorResponse #
NFData CreateConnectorResponse Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector Methods rnf :: CreateConnectorResponse -> () #
type Rep CreateConnectorResponse Source #
Instance details Defined in Amazonka.KafkaConnect.CreateConnector type Rep CreateConnectorResponse = D1 ('MetaData "CreateConnectorResponse" "Amazonka.KafkaConnect.CreateConnector" "libZSservicesZSamazonka-kafkaconnectZSamazonka-kafkaconnect" 'False) (C1 ('MetaCons "CreateConnectorResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "connectorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "connectorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "connectorState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectorState)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))