Managed Streaming for Kafka Connect¶

Description¶

Managed Streaming for Kafka Connect

Usage¶

kafkaconnect(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.
- credentials:
  - creds:
    - access_key_id: AWS access key ID
    - secret_access_key: AWS secret access key
    - session_token: AWS temporary session token
  - profile: The name of a profile to use. If not given, then the default profile is used.
  - anonymous: Set anonymous credentials.
- endpoint: The complete URL to use for the constructed client.
- region: The AWS Region used in instantiating the client.
- close_connection: Immediately close all HTTP connections.
- timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
- s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
- sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
- use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.
credentials

Optional credentials shorthand for the config parameter
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint

Optional shorthand for complete URL to use for the constructed client.
region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- kafkaconnect(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string",
    use_dual_stack = "logical"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

`create_connector`	Creates a connector using the specified properties
`create_custom_plugin`	Creates a custom plugin using the specified properties
`create_worker_configuration`	Creates a worker configuration using the specified properties
`delete_connector`	Deletes the specified connector
`delete_custom_plugin`	Deletes a custom plugin
`delete_worker_configuration`	Deletes the specified worker configuration
`describe_connector`	Returns summary information about the connector
`describe_connector_operation`	Returns information about the specified connector's operations
`describe_custom_plugin`	A summary description of the custom plugin
`describe_worker_configuration`	Returns information about a worker configuration
`list_connector_operations`	Lists information about a connector's operation(s)
`list_connectors`	Returns a list of all the connectors in this account and Region
`list_custom_plugins`	Returns a list of all of the custom plugins in this account and Region
`list_tags_for_resource`	Lists all the tags attached to the specified resource
`list_worker_configurations`	Returns a list of all of the worker configurations in this account and Region
`restart_connector`	Restarts the specified connector
`tag_resource`	Attaches tags to the specified resource
`untag_resource`	Removes tags from the specified resource
`update_connector`	Updates the specified connector

Examples¶

svc <- kafkaconnect()
svc$create_connector(
  Foo = 123
)