cloudera.cloud.df_customflow_info module – Gather information about CDP DataFlow Custom Flow 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_customflow_info.

New in cloudera.cloud 1.6.0

Synopsis

  • Gather information about CDP DataFlow Custom Flow Definitions

  • Custom flows are user-created flow definitions uploaded to the DataFlow catalog

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.

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"

include_details

boolean

If set to false, only a summary of each flow is returned

If set to true, detailed information including versions is returned

Choices:

  • false ← (default)

  • true

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

If a search term is provided, flows matching this term will be returned

Searches by flow name

strict

aliases: strict_errors

boolean

Legacy CDPy SDK error handling.

Choices:

  • false ← (default)

  • true

Examples

# Note: These examples do not set authentication details.

# List basic information about all DataFlow Custom Flows (summary only)
- cloudera.cloud.df_customflow_info:

# Search for flows matching a name (summary only)
- cloudera.cloud.df_customflow_info:
    search_term: my-custom-flow

# Search for flows matching a name with detailed information
- cloudera.cloud.df_customflow_info:
    search_term: my-custom-flow
    include_details: true

# Using the 'name' alias (backward compatibility)
- cloudera.cloud.df_customflow_info:
    name: my-custom-flow

Return Values

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

Key

Description

flows

list / elements=complex

The information about the named DataFlow Custom Flow or DataFlow Custom Flows

Returned: always

artifactType

string

The type of artifact

Returned: always

author

string

Author of the most recent version

Returned: when include_details is True

collectionCrn

string

The collection CRN

Returned: when available

collectionName

string

The collection name

Returned: when available

createdTimestamp

integer

The created timestamp (milliseconds since epoch)

Returned: when include_details is True

crn

string

The artifact CRN

Returned: always

description

string

The artifact description

Returned: when include_details is True

modifiedTimestamp

integer

The modified timestamp (milliseconds since epoch)

Returned: when available

name

string

The artifact name

Returned: always

versionCount

integer

The number of versions uploaded to the catalog

Returned: always

versions

list / elements=dictionary

The list of flow versions

Returned: when include_details is True

author

string

The author of the flow

Returned: when available

bucketIdentifier

string

The bucketIdentifier of the flow

Returned: when available

comments

string

Comments about the flow

Returned: when available

crn

string

The flow version CRN

Returned: always

deploymentCount

integer

The number of deployments of the flow

Returned: when available

draftCount

integer

The number of draft flows associated with the version

Returned: when available

tags

list / elements=dictionary

The list of tags associated with the flow version

Returned: when available

tagColor

string

The color of the version tag

Returned: when available

tagName

string

The name of the version tag

Returned: always

timestamp

integer

The timestamp of the flow (milliseconds since epoch)

Returned: when available

version

integer

The version of the flow

Returned: when available

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)