libZSservicesZSamazonka-kafkaconnectZSamazonka-kafkaconnect
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.KafkaConnect.Lens

Description

 
Synopsis

Operations

ListWorkerConfigurations

listWorkerConfigurations_nextToken :: Lens' ListWorkerConfigurations (Maybe Text) Source #

If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

listWorkerConfigurations_maxResults :: Lens' ListWorkerConfigurations (Maybe Natural) Source #

The maximum number of worker configurations to list in one response.

listWorkerConfigurationsResponse_nextToken :: Lens' ListWorkerConfigurationsResponse (Maybe Text) Source #

If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

DescribeCustomPlugin

describeCustomPlugin_customPluginArn :: Lens' DescribeCustomPlugin Text Source #

Returns information about a custom plugin.

describeCustomPluginResponse_latestRevision :: Lens' DescribeCustomPluginResponse (Maybe CustomPluginRevisionSummary) Source #

The latest successfully created revision of the custom plugin. If there are no successfully created revisions, this field will be absent.

describeCustomPluginResponse_customPluginArn :: Lens' DescribeCustomPluginResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the custom plugin.

DeleteConnector

deleteConnector_currentVersion :: Lens' DeleteConnector (Maybe Text) Source #

The current version of the connector that you want to delete.

deleteConnector_connectorArn :: Lens' DeleteConnector Text Source #

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

deleteConnectorResponse_connectorArn :: Lens' DeleteConnectorResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the connector that you requested to delete.

deleteConnectorResponse_connectorState :: Lens' DeleteConnectorResponse (Maybe ConnectorState) Source #

The state of the connector that you requested to delete.

UpdateConnector

updateConnector_connectorArn :: Lens' UpdateConnector Text Source #

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

updateConnector_currentVersion :: Lens' UpdateConnector Text Source #

The current version of the connector that you want to update.

updateConnectorResponse_connectorArn :: Lens' UpdateConnectorResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the connector.

CreateWorkerConfiguration

createWorkerConfiguration_description :: Lens' CreateWorkerConfiguration (Maybe Text) Source #

A summary description of the worker configuration.

createWorkerConfiguration_propertiesFileContent :: Lens' CreateWorkerConfiguration Text Source #

Base64 encoded contents of connect-distributed.properties file.

createWorkerConfigurationResponse_workerConfigurationArn :: Lens' CreateWorkerConfigurationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) that Amazon assigned to the worker configuration.

ListConnectors

listConnectors_connectorNamePrefix :: Lens' ListConnectors (Maybe Text) Source #

The name prefix that you want to use to search for and list connectors.

listConnectors_nextToken :: Lens' ListConnectors (Maybe Text) Source #

If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

listConnectors_maxResults :: Lens' ListConnectors (Maybe Natural) Source #

The maximum number of connectors to list in one response.

listConnectorsResponse_nextToken :: Lens' ListConnectorsResponse (Maybe Text) Source #

If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where it left off.

ListCustomPlugins

listCustomPlugins_nextToken :: Lens' ListCustomPlugins (Maybe Text) Source #

If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

listCustomPlugins_maxResults :: Lens' ListCustomPlugins (Maybe Natural) Source #

The maximum number of custom plugins to list in one response.

listCustomPluginsResponse_nextToken :: Lens' ListCustomPluginsResponse (Maybe Text) Source #

If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

CreateConnector

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

createConnectorResponse_connectorArn :: Lens' CreateConnectorResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) that Amazon assigned to the connector.

DescribeWorkerConfiguration

describeWorkerConfiguration_workerConfigurationArn :: Lens' DescribeWorkerConfiguration Text Source #

The Amazon Resource Name (ARN) of the worker configuration that you want to get information about.

DescribeConnector

describeConnector_connectorArn :: Lens' DescribeConnector Text Source #

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

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

The Apache Kafka cluster that the connector is connected to.

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_connectorConfiguration :: Lens' DescribeConnectorResponse (Maybe (HashMap Text Text)) Source #

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

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

The Amazon Resource Name (ARN) of the connector.

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

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

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

Specifies which plugins were used for this connector.

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

CreateCustomPlugin

createCustomPlugin_description :: Lens' CreateCustomPlugin (Maybe Text) Source #

A summary description of the custom plugin.

createCustomPlugin_location :: Lens' CreateCustomPlugin CustomPluginLocation Source #

Information about the location of a custom plugin.

createCustomPlugin_name :: Lens' CreateCustomPlugin Text Source #

The name of the custom plugin.

createCustomPluginResponse_customPluginArn :: Lens' CreateCustomPluginResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) that Amazon assigned to the custom plugin.

Types

ApacheKafkaCluster

apacheKafkaCluster_vpc :: Lens' ApacheKafkaCluster Vpc Source #

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

ApacheKafkaClusterDescription

apacheKafkaClusterDescription_vpc :: Lens' ApacheKafkaClusterDescription (Maybe VpcDescription) Source #

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

AutoScaling

autoScaling_scaleInPolicy :: Lens' AutoScaling (Maybe ScaleInPolicy) Source #

The sacle-in policy for the connector.

autoScaling_scaleOutPolicy :: Lens' AutoScaling (Maybe ScaleOutPolicy) Source #

The sacle-out policy for the connector.

autoScaling_maxWorkerCount :: Lens' AutoScaling Natural Source #

The maximum number of workers allocated to the connector.

autoScaling_mcuCount :: Lens' AutoScaling Natural Source #

The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

autoScaling_minWorkerCount :: Lens' AutoScaling Natural Source #

The minimum number of workers allocated to the connector.

AutoScalingDescription

autoScalingDescription_mcuCount :: Lens' AutoScalingDescription (Maybe Int) Source #

The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

autoScalingDescription_maxWorkerCount :: Lens' AutoScalingDescription (Maybe Int) Source #

The maximum number of workers allocated to the connector.

autoScalingDescription_minWorkerCount :: Lens' AutoScalingDescription (Maybe Int) Source #

The minimum number of workers allocated to the connector.

AutoScalingUpdate

autoScalingUpdate_maxWorkerCount :: Lens' AutoScalingUpdate Natural Source #

The target maximum number of workers allocated to the connector.

autoScalingUpdate_mcuCount :: Lens' AutoScalingUpdate Natural Source #

The target number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

autoScalingUpdate_minWorkerCount :: Lens' AutoScalingUpdate Natural Source #

The target minimum number of workers allocated to the connector.

autoScalingUpdate_scaleInPolicy :: Lens' AutoScalingUpdate ScaleInPolicyUpdate Source #

The target sacle-in policy for the connector.

autoScalingUpdate_scaleOutPolicy :: Lens' AutoScalingUpdate ScaleOutPolicyUpdate Source #

The target sacle-out policy for the connector.

Capacity

capacity_autoScaling :: Lens' Capacity (Maybe AutoScaling) Source #

Information about the auto scaling parameters for the connector.

capacity_provisionedCapacity :: Lens' Capacity (Maybe ProvisionedCapacity) Source #

Details about a fixed capacity allocated to a connector.

CapacityDescription

CapacityUpdate

CloudWatchLogsLogDelivery

cloudWatchLogsLogDelivery_logGroup :: Lens' CloudWatchLogsLogDelivery (Maybe Text) Source #

The name of the CloudWatch log group that is the destination for log delivery.

cloudWatchLogsLogDelivery_enabled :: Lens' CloudWatchLogsLogDelivery Bool Source #

Whether log delivery to Amazon CloudWatch Logs is enabled.

CloudWatchLogsLogDeliveryDescription

cloudWatchLogsLogDeliveryDescription_enabled :: Lens' CloudWatchLogsLogDeliveryDescription (Maybe Bool) Source #

Whether log delivery to Amazon CloudWatch Logs is enabled.

cloudWatchLogsLogDeliveryDescription_logGroup :: Lens' CloudWatchLogsLogDeliveryDescription (Maybe Text) Source #

The name of the CloudWatch log group that is the destination for log delivery.

ConnectorSummary

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

The time that the connector was created.

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

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

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_currentVersion :: Lens' ConnectorSummary (Maybe Text) Source #

The current version of the connector.

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

The worker configurations that are in use with the connector.

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

The Amazon Resource Name (ARN) of the connector.

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

The connector's compute capacity settings.

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

Specifies which plugins were used for this connector.

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

CustomPlugin

customPlugin_customPluginArn :: Lens' CustomPlugin Text Source #

The Amazon Resource Name (ARN) of the custom plugin.

customPlugin_revision :: Lens' CustomPlugin Natural Source #

The revision of the custom plugin.

CustomPluginDescription

customPluginDescription_customPluginArn :: Lens' CustomPluginDescription (Maybe Text) Source #

The Amazon Resource Name (ARN) of the custom plugin.

CustomPluginFileDescription

customPluginFileDescription_fileMd5 :: Lens' CustomPluginFileDescription (Maybe Text) Source #

The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.

customPluginFileDescription_fileSize :: Lens' CustomPluginFileDescription (Maybe Integer) Source #

The size in bytes of the custom plugin file. You can use it to validate the file.

CustomPluginLocation

customPluginLocation_s3Location :: Lens' CustomPluginLocation S3Location Source #

The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.

CustomPluginLocationDescription

customPluginLocationDescription_s3Location :: Lens' CustomPluginLocationDescription (Maybe S3LocationDescription) Source #

The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.

CustomPluginRevisionSummary

CustomPluginSummary

customPluginSummary_creationTime :: Lens' CustomPluginSummary (Maybe UTCTime) Source #

The time that the custom plugin was created.

customPluginSummary_customPluginArn :: Lens' CustomPluginSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the custom plugin.

FirehoseLogDelivery

firehoseLogDelivery_deliveryStream :: Lens' FirehoseLogDelivery (Maybe Text) Source #

The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.

firehoseLogDelivery_enabled :: Lens' FirehoseLogDelivery Bool Source #

Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.

FirehoseLogDeliveryDescription

firehoseLogDeliveryDescription_enabled :: Lens' FirehoseLogDeliveryDescription (Maybe Bool) Source #

Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.

firehoseLogDeliveryDescription_deliveryStream :: Lens' FirehoseLogDeliveryDescription (Maybe Text) Source #

The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.

KafkaCluster

kafkaCluster_apacheKafkaCluster :: Lens' KafkaCluster ApacheKafkaCluster Source #

The Apache Kafka cluster to which the connector is connected.

KafkaClusterClientAuthentication

kafkaClusterClientAuthentication_authenticationType :: Lens' KafkaClusterClientAuthentication KafkaClusterClientAuthenticationType Source #

The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.

KafkaClusterClientAuthenticationDescription

kafkaClusterClientAuthenticationDescription_authenticationType :: Lens' KafkaClusterClientAuthenticationDescription (Maybe KafkaClusterClientAuthenticationType) Source #

The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.

KafkaClusterDescription

KafkaClusterEncryptionInTransit

KafkaClusterEncryptionInTransitDescription

LogDelivery

logDelivery_workerLogDelivery :: Lens' LogDelivery WorkerLogDelivery Source #

The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.

LogDeliveryDescription

logDeliveryDescription_workerLogDelivery :: Lens' LogDeliveryDescription (Maybe WorkerLogDeliveryDescription) Source #

The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.

Plugin

plugin_customPlugin :: Lens' Plugin CustomPlugin Source #

Details about a custom plugin.

PluginDescription

ProvisionedCapacity

provisionedCapacity_mcuCount :: Lens' ProvisionedCapacity Natural Source #

The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

provisionedCapacity_workerCount :: Lens' ProvisionedCapacity Natural Source #

The number of workers that are allocated to the connector.

ProvisionedCapacityDescription

provisionedCapacityDescription_workerCount :: Lens' ProvisionedCapacityDescription (Maybe Int) Source #

The number of workers that are allocated to the connector.

provisionedCapacityDescription_mcuCount :: Lens' ProvisionedCapacityDescription (Maybe Int) Source #

The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

ProvisionedCapacityUpdate

provisionedCapacityUpdate_mcuCount :: Lens' ProvisionedCapacityUpdate Natural Source #

The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

provisionedCapacityUpdate_workerCount :: Lens' ProvisionedCapacityUpdate Natural Source #

The number of workers that are allocated to the connector.

S3Location

s3Location_objectVersion :: Lens' S3Location (Maybe Text) Source #

The version of an object in an S3 bucket.

s3Location_bucketArn :: Lens' S3Location Text Source #

The Amazon Resource Name (ARN) of an S3 bucket.

s3Location_fileKey :: Lens' S3Location Text Source #

The file key for an object in an S3 bucket.

S3LocationDescription

s3LocationDescription_objectVersion :: Lens' S3LocationDescription (Maybe Text) Source #

The version of an object in an S3 bucket.

s3LocationDescription_bucketArn :: Lens' S3LocationDescription (Maybe Text) Source #

The Amazon Resource Name (ARN) of an S3 bucket.

s3LocationDescription_fileKey :: Lens' S3LocationDescription (Maybe Text) Source #

The file key for an object in an S3 bucket.

S3LogDelivery

s3LogDelivery_prefix :: Lens' S3LogDelivery (Maybe Text) Source #

The S3 prefix that is the destination for log delivery.

s3LogDelivery_bucket :: Lens' S3LogDelivery (Maybe Text) Source #

The name of the S3 bucket that is the destination for log delivery.

s3LogDelivery_enabled :: Lens' S3LogDelivery Bool Source #

Specifies whether connector logs get sent to the specified Amazon S3 destination.

S3LogDeliveryDescription

s3LogDeliveryDescription_enabled :: Lens' S3LogDeliveryDescription (Maybe Bool) Source #

Specifies whether connector logs get sent to the specified Amazon S3 destination.

s3LogDeliveryDescription_prefix :: Lens' S3LogDeliveryDescription (Maybe Text) Source #

The S3 prefix that is the destination for log delivery.

s3LogDeliveryDescription_bucket :: Lens' S3LogDeliveryDescription (Maybe Text) Source #

The name of the S3 bucket that is the destination for log delivery.

ScaleInPolicy

scaleInPolicy_cpuUtilizationPercentage :: Lens' ScaleInPolicy Natural Source #

Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.

ScaleInPolicyDescription

scaleInPolicyDescription_cpuUtilizationPercentage :: Lens' ScaleInPolicyDescription (Maybe Int) Source #

Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.

ScaleInPolicyUpdate

scaleInPolicyUpdate_cpuUtilizationPercentage :: Lens' ScaleInPolicyUpdate Natural Source #

The target CPU utilization percentage threshold at which you want connector scale in to be triggered.

ScaleOutPolicy

scaleOutPolicy_cpuUtilizationPercentage :: Lens' ScaleOutPolicy Natural Source #

The CPU utilization percentage threshold at which you want connector scale out to be triggered.

ScaleOutPolicyDescription

scaleOutPolicyDescription_cpuUtilizationPercentage :: Lens' ScaleOutPolicyDescription (Maybe Int) Source #

The CPU utilization percentage threshold at which you want connector scale out to be triggered.

ScaleOutPolicyUpdate

scaleOutPolicyUpdate_cpuUtilizationPercentage :: Lens' ScaleOutPolicyUpdate Natural Source #

The target CPU utilization percentage threshold at which you want connector scale out to be triggered.

Vpc

vpc_securityGroups :: Lens' Vpc (Maybe [Text]) Source #

The security groups for the connector.

vpc_subnets :: Lens' Vpc [Text] Source #

The subnets for the connector.

VpcDescription

vpcDescription_securityGroups :: Lens' VpcDescription (Maybe [Text]) Source #

The security groups for the connector.

vpcDescription_subnets :: Lens' VpcDescription (Maybe [Text]) Source #

The subnets for the connector.

WorkerConfiguration

workerConfiguration_revision :: Lens' WorkerConfiguration Natural Source #

The revision of the worker configuration.

workerConfiguration_workerConfigurationArn :: Lens' WorkerConfiguration Text Source #

The Amazon Resource Name (ARN) of the worker configuration.

WorkerConfigurationDescription

workerConfigurationDescription_workerConfigurationArn :: Lens' WorkerConfigurationDescription (Maybe Text) Source #

The Amazon Resource Name (ARN) of the worker configuration.

WorkerConfigurationRevisionDescription

WorkerConfigurationRevisionSummary

WorkerConfigurationSummary

workerConfigurationSummary_creationTime :: Lens' WorkerConfigurationSummary (Maybe UTCTime) Source #

The time that a worker configuration was created.

workerConfigurationSummary_workerConfigurationArn :: Lens' WorkerConfigurationSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the worker configuration.

WorkerLogDelivery

workerLogDelivery_cloudWatchLogs :: Lens' WorkerLogDelivery (Maybe CloudWatchLogsLogDelivery) Source #

Details about delivering logs to Amazon CloudWatch Logs.

workerLogDelivery_firehose :: Lens' WorkerLogDelivery (Maybe FirehoseLogDelivery) Source #

Details about delivering logs to Amazon Kinesis Data Firehose.

workerLogDelivery_s3 :: Lens' WorkerLogDelivery (Maybe S3LogDelivery) Source #

Details about delivering logs to Amazon S3.

WorkerLogDeliveryDescription