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.KafkaConnect.Types.ConnectorSummary

Description

Synopsis

Documentation

data ConnectorSummary Source #

Summary of a connector.

See: newConnectorSummary smart constructor.

Constructors

ConnectorSummary'

Fields

capacity :: Maybe CapacityDescription
The connector's compute capacity settings.
connectorArn :: Maybe Text
The Amazon Resource Name (ARN) of the connector.
connectorDescription :: Maybe Text
The description of the connector.
connectorName :: Maybe Text
The name of the connector.
connectorState :: Maybe ConnectorState
The state of the connector.
creationTime :: Maybe ISO8601
The time that the connector was created.
currentVersion :: Maybe Text
The current version of the connector.
kafkaCluster :: Maybe KafkaClusterDescription
The details of the Apache Kafka cluster to which the connector is connected.
kafkaClusterClientAuthentication :: Maybe KafkaClusterClientAuthenticationDescription
The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.
kafkaClusterEncryptionInTransit :: Maybe KafkaClusterEncryptionInTransitDescription
Details of encryption in transit to the Apache Kafka cluster.
kafkaConnectVersion :: Maybe Text
The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.
logDelivery :: Maybe LogDeliveryDescription
The settings for delivering connector logs to Amazon CloudWatch Logs.
plugins :: Maybe [PluginDescription]
Specifies which plugins were used for this connector.
serviceExecutionRoleArn :: Maybe Text
The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
workerConfiguration :: Maybe WorkerConfigurationDescription
The worker configurations that are in use with the connector.

Instances

Instances details

FromJSON ConnectorSummary Source #
Instance details Defined in Amazonka.KafkaConnect.Types.ConnectorSummary Methods parseJSON :: Value -> Parser ConnectorSummary # parseJSONList :: Value -> Parser [ConnectorSummary] #
Generic ConnectorSummary Source #
Instance details Defined in Amazonka.KafkaConnect.Types.ConnectorSummary Associated Types type Rep ConnectorSummary :: Type -> Type # Methods from :: ConnectorSummary -> Rep ConnectorSummary x # to :: Rep ConnectorSummary x -> ConnectorSummary #
Read ConnectorSummary Source #
Instance details Defined in Amazonka.KafkaConnect.Types.ConnectorSummary Methods readsPrec :: Int -> ReadS ConnectorSummary # readList :: ReadS [ConnectorSummary] # readPrec :: ReadPrec ConnectorSummary # readListPrec :: ReadPrec [ConnectorSummary] #
Show ConnectorSummary Source #
Instance details Defined in Amazonka.KafkaConnect.Types.ConnectorSummary Methods showsPrec :: Int -> ConnectorSummary -> ShowS # show :: ConnectorSummary -> String # showList :: [ConnectorSummary] -> ShowS #
NFData ConnectorSummary Source #
Instance details Defined in Amazonka.KafkaConnect.Types.ConnectorSummary Methods rnf :: ConnectorSummary -> () #
Eq ConnectorSummary Source #
Instance details Defined in Amazonka.KafkaConnect.Types.ConnectorSummary Methods (==) :: ConnectorSummary -> ConnectorSummary -> Bool # (/=) :: ConnectorSummary -> ConnectorSummary -> Bool #
Hashable ConnectorSummary Source #
Instance details Defined in Amazonka.KafkaConnect.Types.ConnectorSummary Methods hashWithSalt :: Int -> ConnectorSummary -> Int # hash :: ConnectorSummary -> Int #
type Rep ConnectorSummary Source #
Instance details Defined in Amazonka.KafkaConnect.Types.ConnectorSummary type Rep ConnectorSummary = D1 ('MetaData "ConnectorSummary" "Amazonka.KafkaConnect.Types.ConnectorSummary" "amazonka-kafkaconnect-2.0-4ed6DFGevt995RzDsMjJqs" 'False) (C1 ('MetaCons "ConnectorSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "capacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CapacityDescription)) :: (S1 ('MetaSel ('Just "connectorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "connectorDescription") '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 "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "currentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "kafkaCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KafkaClusterDescription)) :: S1 ('MetaSel ('Just "kafkaClusterClientAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KafkaClusterClientAuthenticationDescription))) :: (S1 ('MetaSel ('Just "kafkaClusterEncryptionInTransit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KafkaClusterEncryptionInTransitDescription)) :: S1 ('MetaSel ('Just "kafkaConnectVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "logDelivery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogDeliveryDescription)) :: S1 ('MetaSel ('Just "plugins") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PluginDescription]))) :: (S1 ('MetaSel ('Just "serviceExecutionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "workerConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkerConfigurationDescription)))))))

newConnectorSummary :: ConnectorSummary Source #

Create a value of ConnectorSummary 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:capacity:ConnectorSummary', connectorSummary_capacity - The connector's compute capacity settings.

$sel:connectorArn:ConnectorSummary', connectorSummary_connectorArn - The Amazon Resource Name (ARN) of the connector.

$sel:connectorDescription:ConnectorSummary', connectorSummary_connectorDescription - The description of the connector.

$sel:connectorName:ConnectorSummary', connectorSummary_connectorName - The name of the connector.

$sel:connectorState:ConnectorSummary', connectorSummary_connectorState - The state of the connector.

$sel:creationTime:ConnectorSummary', connectorSummary_creationTime - The time that the connector was created.

$sel:currentVersion:ConnectorSummary', connectorSummary_currentVersion - The current version of the connector.

$sel:kafkaCluster:ConnectorSummary', connectorSummary_kafkaCluster - The details of the Apache Kafka cluster to which the connector is connected.

$sel:kafkaClusterClientAuthentication:ConnectorSummary', connectorSummary_kafkaClusterClientAuthentication - The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.

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

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

$sel:logDelivery:ConnectorSummary', connectorSummary_logDelivery - The settings for delivering connector logs to Amazon CloudWatch Logs.

$sel:plugins:ConnectorSummary', connectorSummary_plugins - Specifies which plugins were used for this connector.

$sel:serviceExecutionRoleArn:ConnectorSummary', connectorSummary_serviceExecutionRoleArn - The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.

$sel:workerConfiguration:ConnectorSummary', connectorSummary_workerConfiguration - The worker configurations that are in use with the connector.

connectorSummary_capacity :: Lens' ConnectorSummary (Maybe CapacityDescription) Source #

The connector's compute capacity settings.

connectorSummary_connectorArn :: Lens' ConnectorSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the connector.

connectorSummary_connectorDescription :: Lens' ConnectorSummary (Maybe Text) Source #

The description of the connector.

connectorSummary_connectorName :: Lens' ConnectorSummary (Maybe Text) Source #

The name of the connector.

connectorSummary_connectorState :: Lens' ConnectorSummary (Maybe ConnectorState) Source #

The state of the connector.

connectorSummary_creationTime :: Lens' ConnectorSummary (Maybe UTCTime) Source #

The time that the connector was created.

connectorSummary_currentVersion :: Lens' ConnectorSummary (Maybe Text) Source #

The current version of the connector.

connectorSummary_kafkaCluster :: Lens' ConnectorSummary (Maybe KafkaClusterDescription) Source #

The details of the Apache Kafka cluster to which the connector is connected.

connectorSummary_kafkaClusterClientAuthentication :: Lens' ConnectorSummary (Maybe KafkaClusterClientAuthenticationDescription) Source #

The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.

connectorSummary_kafkaClusterEncryptionInTransit :: Lens' ConnectorSummary (Maybe KafkaClusterEncryptionInTransitDescription) Source #

Details of encryption in transit to the Apache Kafka cluster.

connectorSummary_kafkaConnectVersion :: Lens' ConnectorSummary (Maybe Text) Source #

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

connectorSummary_logDelivery :: Lens' ConnectorSummary (Maybe LogDeliveryDescription) Source #

The settings for delivering connector logs to Amazon CloudWatch Logs.

connectorSummary_plugins :: Lens' ConnectorSummary (Maybe [PluginDescription]) Source #

Specifies which plugins were used for this connector.

connectorSummary_serviceExecutionRoleArn :: Lens' ConnectorSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.

connectorSummary_workerConfiguration :: Lens' ConnectorSummary (Maybe WorkerConfigurationDescription) Source #

The worker configurations that are in use with the connector.