cloudera.cloud.df_readyflow_info module – Gather information about CDP DataFlow ReadyFlow Definitions

Note

This module is part of the cloudera.cloud collection (version 3.1.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.df_readyflow_info.

New in cloudera.cloud 1.6.0

Synopsis

  • Gather information about CDP DataFlow ReadyFlow Definitions

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.

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.

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"

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"

search_term

aliases: name

string

Search term to filter ReadyFlows (matches name, summary, or other fields)

If no search_term is provided, all ReadyFlows are returned

strict

aliases: strict_errors

boolean

Legacy CDPy SDK error handling.

Choices:

  • false ← (default)

  • true

Notes

Note

  • This feature this module is for is in Technical Preview

Examples

# Note: These examples do not set authentication details.

- name: Gather information about all DataFlow ReadyFlows
   cloudera.cloud.df_readyflow_info:

- name: Gather information about ReadyFlows matching a search term
  cloudera.cloud.df_readyflow_info:
    search_term: "Kafka"

- name: Gather information about a specific DataFlow ReadyFlow
  cloudera.cloud.df_readyflow_info:
    name: "Kafka to S3 Avro"

Return Values

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

Key

Description

readyflows

list / elements=dictionary

Returns a list of ReadyFlow details from the DataFlow catalog

Returned: always

author

string

The author of the most recent version

Returned: always

description

string

The ReadyFlow description (long description)

Returned: when supported

destination

string

The ReadyFlow data destination

Returned: when supported

destinationDataFormat

string

The ReadyFlow data destination format

Returned: when supported

string

A link to the ReadyFlow documentation

Returned: when supported

imported

boolean

Whether the ReadyFlow has been imported into the current account

Returned: when supported

modifiedTimestamp

integer

The modified timestamp

Returned: when supported

name

string

The ReadyFlow name

Returned: always

notes

string

Optional notes about the ReadyFlow

Returned: when supported

readyflowCrn

string

The CRN of the ReadyFlow

Returned: always

source

string

The ReadyFlow data source

Returned: when supported

sourceDataFormat

string

The ReadyFlow data source format

Returned: when supported

summary

string

The ReadyFlow summary (short description)

Returned: when supported

sdk_out

string

Returns the captured API HTTP log.

Returned: when supported

sdk_out_lines

list / elements=string

Returns a list of each line of the captured API HTTP log.

Returned: when supported

Authors

  • Dan Chaffelson (@chaffelson)

  • Ronald Suplina (@rsuplina)