cloudera.cloud.dw_connector_info module – Gather information about CDP Data Warehouse Connectors

Note

This module is part of the cloudera.cloud collection (version 3.3.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cloudera.cloud.

To use it in a playbook, specify: cloudera.cloud.dw_connector_info.

New in cloudera.cloud 3.4.0

Synopsis

  • Gather information about CDP Data Warehouse Connectors

  • The module supports check_mode.

Parameters

Parameter

Comments

access_key

string

If provided, the Cloudera on cloud API will use this value as its access key.

If not provided, the API will attempt to use the value from the environment variable CDP_ACCESS_KEY_ID.

Required if private_key is provided.

Mutually exclusive with credentials_path.

cluster_id

aliases: id

string / required

The identifier of the Data Warehouse Cluster.

connector_id

aliases: connector_identifier

string

The ID of the connector to query.

Mutually exclusive with name.

credentials_path

string

If provided, the Cloudera on cloud API will use this value as its credentials path.

If not provided, the API will attempt to use the value from the environment variable CDP_CREDENTIALS_PATH.

Default: "~/.cdp/credentials"

debug

aliases: debug_endpoints

boolean

If true, the module will capture the Cloudera on cloud HTTP log and return it in the sdk_out and sdk_out_lines fields.

Choices:

  • false ← (default)

  • true

endpoint

aliases: endpoint_url, url

string

The Cloudera on cloud API endpoint to use.

If not provided, the API will attempt to use the value from the environment variable CDP_ENDPOINT_URL.

Mutually exclusive with endpoint_region.

endpoint_region

aliases: cdp_endpoint_region, cdp_region, region

string

Specify the Cloudera on cloud API endpoint region.

See Cloudera Control Plane regions for more information.

If not provided, the API will attempt to use the value from the environment variable CDP_REGION.

default is an alias for the us-west-1 region.

Mutually exclusive with endpoint.

Choices:

  • "default"

  • "us-west-1" ← (default)

  • "eu-1"

  • "ap-1"

endpoint_tls

aliases: verify_endpoint_tls, verify_tls, verify_api_tls

boolean

Verify the TLS certificates for the Cloudera on cloud API endpoint.

Choices:

  • false

  • true ← (default)

http_agent

aliases: agent_header

string

The HTTP user agent to use for Cloudera on cloud API requests.

Default: "cloudera.cloud"

name

string

The name of the connector to query.

Mutually exclusive with connector_id.

private_key

string

If provided, the Cloudera on cloud API will use this value as its private key.

If not provided, the API will attempt to use the value from the environment variable CDP_PRIVATE_KEY.

Required if access_key is provided.

profile

string

If provided, the Cloudera on cloud API will use this value as its profile.

If not provided, the API will attempt to use the value from the environment variable CDP_PROFILE.

Default: "default"

strict

aliases: strict_errors

boolean

Legacy CDPy SDK error handling.

Choices:

  • false ← (default)

  • true

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped.

diff_mode

Support: N/A

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

platform

Platforms: all

Target OS/families that can be operated against

Examples

# Note: These examples do not set authentication details.

# List all connectors in a cluster
- cloudera.cloud.dw_connector_info:
    cluster_id: example-cluster-id

# Get a specific connector by ID
- cloudera.cloud.dw_connector_info:
    cluster_id: example-cluster-id
    connector_id: example-connector-id

# Get a specific connector by name
- cloudera.cloud.dw_connector_info:
    cluster_id: example-cluster-id
    name: example-connector-name

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

connectors

list / elements=dictionary

The information about the connector(s)

Returned: always

config

dictionary

The connector configuration in key-value format

Returned: when available

createdAt

integer

The timestamp when the connector was created

Returned: always

createdBy

string

The CRN of the user who created the connector

Returned: always

crn

string

The CRN of the connector

Returned: always

description

string

User-provided description

Returned: when available

id

string

The unique identifier of the connector

Returned: always

name

string

The name of the connector

Returned: always

template

string

The template of the connector

Returned: always

updatedAt

integer

The timestamp when the connector was last updated

Returned: always

updatedBy

string

The CRN of the user who last updated the connector

Returned: always

sdk_out

string

Returns the captured CDP SDK log.

Returned: when debug is true

sdk_out_lines

list / elements=string

Returns a list of each line of the captured CDP SDK log.

Returned: when debug is true

Authors

  • Webster Mudge (@wmudge)