- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
KafkaConnectClient
Installation
npm install @aws-sdk/client-kafkaconnect
yarn add @aws-sdk/client-kafkaconnect
pnpm add @aws-sdk/client-kafkaconnect
KafkaConnectClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CreateConnectorCommand | Creates a connector using the specified properties. |
CreateCustomPluginCommand | Creates a custom plugin using the specified properties. |
CreateWorkerConfigurationCommand | Creates a worker configuration using the specified properties. |
DeleteConnectorCommand | Deletes the specified connector. |
DeleteCustomPluginCommand | Deletes a custom plugin. |
DeleteWorkerConfigurationCommand | Deletes the specified worker configuration. |
DescribeConnectorCommand | Returns summary information about the connector. |
DescribeConnectorOperationCommand | Returns information about the specified connector's operations. |
DescribeCustomPluginCommand | A summary description of the custom plugin. |
DescribeWorkerConfigurationCommand | Returns information about a worker configuration. |
ListConnectorOperationsCommand | Lists information about a connector's operation(s). |
ListConnectorsCommand | Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response also includes a description of each of the listed connectors. |
ListCustomPluginsCommand | Returns a list of all of the custom plugins in this account and Region. |
ListTagsForResourceCommand | Lists all the tags attached to the specified resource. |
ListWorkerConfigurationsCommand | Returns a list of all of the worker configurations in this account and Region. |
TagResourceCommand | Attaches tags to the specified resource. |
UntagResourceCommand | Removes tags from the specified resource. |
UpdateConnectorCommand | Updates the specified connector. |
KafkaConnectClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: KafkaConnectClientConfig