amazonka-kafkaconnect-2.0: Amazon Managed Streaming for Kafka Connect SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.KafkaConnect.DescribeConnector

Description

Returns summary information about the connector.

Synopsis

Creating a Request

data DescribeConnector Source #

See: newDescribeConnector smart constructor.

Constructors

DescribeConnector' 

Fields

  • connectorArn :: Text

    The Amazon Resource Name (ARN) of the connector that you want to describe.

Instances

Instances details
ToHeaders DescribeConnector Source # 
Instance details

Defined in Amazonka.KafkaConnect.DescribeConnector

ToPath DescribeConnector Source # 
Instance details

Defined in Amazonka.KafkaConnect.DescribeConnector

ToQuery DescribeConnector Source # 
Instance details

Defined in Amazonka.KafkaConnect.DescribeConnector

AWSRequest DescribeConnector Source # 
Instance details

Defined in Amazonka.KafkaConnect.DescribeConnector

Associated Types

type AWSResponse DescribeConnector #

Generic DescribeConnector Source # 
Instance details

Defined in Amazonka.KafkaConnect.DescribeConnector

Associated Types

type Rep DescribeConnector :: Type -> Type #

Read DescribeConnector Source # 
Instance details

Defined in Amazonka.KafkaConnect.DescribeConnector

Show DescribeConnector Source # 
Instance details

Defined in Amazonka.KafkaConnect.DescribeConnector

NFData DescribeConnector Source # 
Instance details

Defined in Amazonka.KafkaConnect.DescribeConnector

Methods

rnf :: DescribeConnector -> () #

Eq DescribeConnector Source # 
Instance details

Defined in Amazonka.KafkaConnect.DescribeConnector

Hashable DescribeConnector Source # 
Instance details

Defined in Amazonka.KafkaConnect.DescribeConnector

type AWSResponse DescribeConnector Source # 
Instance details

Defined in Amazonka.KafkaConnect.DescribeConnector

type Rep DescribeConnector Source # 
Instance details

Defined in Amazonka.KafkaConnect.DescribeConnector

type Rep DescribeConnector = D1 ('MetaData "DescribeConnector" "Amazonka.KafkaConnect.DescribeConnector" "amazonka-kafkaconnect-2.0-4ed6DFGevt995RzDsMjJqs" 'False) (C1 ('MetaCons "DescribeConnector'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeConnector Source #

Create a value of DescribeConnector 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:

DescribeConnector, describeConnector_connectorArn - The Amazon Resource Name (ARN) of the connector that you want to describe.

Request Lenses

describeConnector_connectorArn :: Lens' DescribeConnector Text Source #

The Amazon Resource Name (ARN) of the connector that you want to describe.

Destructuring the Response

data DescribeConnectorResponse Source #

See: newDescribeConnectorResponse smart constructor.

Constructors

DescribeConnectorResponse' 

Fields

Instances

Instances details
Generic DescribeConnectorResponse Source # 
Instance details

Defined in Amazonka.KafkaConnect.DescribeConnector

Associated Types

type Rep DescribeConnectorResponse :: Type -> Type #

Show DescribeConnectorResponse Source # 
Instance details

Defined in Amazonka.KafkaConnect.DescribeConnector

NFData DescribeConnectorResponse Source # 
Instance details

Defined in Amazonka.KafkaConnect.DescribeConnector

Eq DescribeConnectorResponse Source # 
Instance details

Defined in Amazonka.KafkaConnect.DescribeConnector

type Rep DescribeConnectorResponse Source # 
Instance details

Defined in Amazonka.KafkaConnect.DescribeConnector

type Rep DescribeConnectorResponse = D1 ('MetaData "DescribeConnectorResponse" "Amazonka.KafkaConnect.DescribeConnector" "amazonka-kafkaconnect-2.0-4ed6DFGevt995RzDsMjJqs" 'False) (C1 ('MetaCons "DescribeConnectorResponse'" '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 "connectorConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text 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 "stateDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StateDescription)) :*: (S1 ('MetaSel ('Just "workerConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkerConfigurationDescription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeConnectorResponse Source #

Create a value of DescribeConnectorResponse 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:

DescribeConnectorResponse, describeConnectorResponse_capacity - Information about the capacity of the connector, whether it is auto scaled or provisioned.

DescribeConnector, describeConnectorResponse_connectorArn - The Amazon Resource Name (ARN) of the connector.

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

DescribeConnectorResponse, describeConnectorResponse_connectorDescription - A summary description of the connector.

DescribeConnectorResponse, describeConnectorResponse_connectorName - The name of the connector.

DescribeConnectorResponse, describeConnectorResponse_connectorState - The state of the connector.

DescribeConnectorResponse, describeConnectorResponse_creationTime - The time the connector was created.

DescribeConnectorResponse, describeConnectorResponse_currentVersion - The current version of the connector.

DescribeConnectorResponse, describeConnectorResponse_kafkaCluster - The Apache Kafka cluster that the connector is connected to.

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

DescribeConnectorResponse, describeConnectorResponse_kafkaClusterEncryptionInTransit - Details of encryption in transit to the Apache Kafka cluster.

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

DescribeConnectorResponse, describeConnectorResponse_logDelivery - Details about delivering logs to Amazon CloudWatch Logs.

DescribeConnectorResponse, describeConnectorResponse_plugins - Specifies which plugins were used for this connector.

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

$sel:stateDescription:DescribeConnectorResponse', describeConnectorResponse_stateDescription - Details about the state of a connector.

DescribeConnectorResponse, describeConnectorResponse_workerConfiguration - Specifies which worker configuration was used for the connector.

$sel:httpStatus:DescribeConnectorResponse', describeConnectorResponse_httpStatus - The response's http status code.

Response Lenses

describeConnectorResponse_capacity :: Lens' DescribeConnectorResponse (Maybe CapacityDescription) Source #

Information about the capacity of the connector, whether it is auto scaled or provisioned.

describeConnectorResponse_connectorArn :: Lens' DescribeConnectorResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the connector.

describeConnectorResponse_connectorConfiguration :: Lens' DescribeConnectorResponse (Maybe (HashMap Text Text)) Source #

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

describeConnectorResponse_kafkaCluster :: Lens' DescribeConnectorResponse (Maybe KafkaClusterDescription) Source #

The Apache Kafka cluster that the connector is connected to.

describeConnectorResponse_kafkaClusterClientAuthentication :: Lens' DescribeConnectorResponse (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.

describeConnectorResponse_kafkaConnectVersion :: Lens' DescribeConnectorResponse (Maybe Text) Source #

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

describeConnectorResponse_plugins :: Lens' DescribeConnectorResponse (Maybe [PluginDescription]) Source #

Specifies which plugins were used for this connector.

describeConnectorResponse_serviceExecutionRoleArn :: Lens' DescribeConnectorResponse (Maybe Text) Source #

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