confluent.cloud.connect_info (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

Enumerate and filter connectors within Confluent Cloud.

Usage examples

Scanned by Steampunk Spotter

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

- name: List all available connectors
  confluent.cloud.connect_info:
    environment: env-f3a90de
    cluster: lkc-6wkr2

Scanned by Steampunk Spotter

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

- name: List all sink connectors
  confluent.cloud.connect_info:
    environment: env-f3a90de
    cluster: lkc-6wkr2
    types:
      - sink

Scanned by Steampunk Spotter

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

- name: List all Datagen connectors
  confluent.cloud.connect_info:
    environment: env-f3a90de
    cluster: lkc-6wkr2
    connectors:
      - DatagenSource

Inputs

    
names:
    description:
    - List of connector Names.
    elements: str
    type: list

types:
    description:
    - List of connector types (sink or source).
    elements: str
    type: list

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

cluster:
    description:
    - The cluster to which this belongs.
    required: true
    type: str

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

connectors:
    description:
    - List of connector classes.
    elements: str
    type: list

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:
    - The environment to which this belongs.
    required: true
    type: str

api_endpoint:
    default: https://api.confluent.cloud
    description: Endpoint used for the API requests.
    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

connectors:
  contains:
    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
  description: Dictionary of matching connectors, keyed by connector name
  returned: success
  type: dict