confluent.cloud.connect (0.1.0) — module

Install collection

Install with ansible-galaxy collection install confluent.cloud:==0.1.0

Add to requirements.yml

  collections:
    - name: confluent.cloud
      version: 0.1.0

Description

Manage Confluent Cloud connectors

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create Datagen connector
  confluent.cloud.connect:
    name: datagen_source
    environment: env-f3a90de
    cluster: lkc-6wkr2
    connector: DatagenSource
    kafka_key: QMQ6AOEJISDAG6FI
    kafka_secret: aeXANrbGCLqzfl6Q7k2Ygi5cSrS+F97TThNTZMSP0AvzF+g8l4iG3PcDJleVrHD8
    props:
      kafka.auth.mode: KAFKA_API_KEY
      kafka.topic: pageviews
      quickstart: PAGEVIEWS
      max.interval: "1200"
      iterations: "100000000"
      output.data.format: JSON
      tasks.max: "1"
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Pause existing connector by name
  confluent.cloud.connect:
    environment: env-f3a90de
    cluster: lkc-6wkr2
    name: datagen_source
    state: pause

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Resume existing connector by name
  confluent.cloud.connect:
    environment: env-f3a90de
    cluster: lkc-6wkr2
    name: datagen_source
    state: resume

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete existing connector by name
  confluent.cloud.connect:
    environment: env-f3a90de
    cluster: lkc-6wkr2
    name: datagen_source
    state: absent

Inputs

    
name:
    description:
    - Unique connector name
    required: true
    type: str

props:
    description:
    - Dictionary of connector-specific properties.  These properties vary by connector
    type: dict

state:
    choices:
    - absent
    - present
    - pause
    - resume
    default: present
    description:
    - If `absent`, the connector will be removed.
    - If `present`, the connector will be created.
    - If `pause`, the connector will be paused.
    - If `resume`, the connector will be resumed.
    type: str

api_key:
    description: Confluent Cloud API Key
    required: true
    type: str

cluster:
    description:
    - Cluster Id.
    required: true
    type: str

connector:
    description:
    - The connector class name. E.g. DatagenSource, BigQuerySink, GcsSink, etc.
    type: str

kafka_key:
    description:
    - Kafka API user key with access to the topics this connector will access.
    - Note this is different than the Cloud Key which is used to mutate Confluent Cloud
      resources.
    type: str

api_secret:
    description: Confluent Cloud API Secret
    required: true
    type: str

api_retries:
    default: 5
    description: Amount of max retries for the API requests.
    type: int

api_timeout:
    default: 60
    description: Timeout used for the API requests.
    type: int

environment:
    description:
    - Environment Id.
    required: true
    type: str

api_endpoint:
    default: https://api.confluent.cloud
    description: Endpoint used for the API requests.
    type: str

kafka_secret:
    description:
    - Kafka API user secret with access to the topics this connector will access.
    - Note this is different than the Cloud Key which is used to mutate Confluent Cloud
      resources.
    type: str

validate_certs:
    default: true
    description: Whether to vaidate API endpoint TLS certs
    type: bool

api_retry_max_delay:
    default: 12
    description: Exponential backoff delay in seconds between retries up to this max delay
      value.
    type: int

Outputs

config:
  description: Dict showing the connector's configuration parameters.  These vary
    by connector class
  returned: success
  type: str
name:
  description: Connector name
  returned: success
  type: str
status:
  description: Dict showing the status of the connector
  returned: success
  type: str
tasks:
  description: Dict showing the status of each connector task
  returned: success
  type: str
type:
  description: Connector type (either source or sink)
  returned: success
  type: str