cloudera.cloud.df_customflow module – Import or Delete CustomFlows into the DataFlow Catalog

Note

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

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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis

  • Import or Delete CustomFlows into the DataFlow Catalog

Requirements

The below requirements are needed on the host that executes this module.

  • cdpy

Parameters

Parameter

Comments

cdp_region

aliases: cdp_endpoint_region, endpoint_region

string

Specify the Cloudera Data Platform endpoint region.

Default: "default"

comments

string

Comments associated to the initial version of the CustomFlow.

Default: "None"

debug

aliases: debug_endpoints

boolean

Capture the CDP SDK debug log.

Choices:

  • false ← (default)

  • true

description

string

The description of the CustomFlow.

Default: "None"

file

string

The JSON file containing the CustomFlow definition to be imported.

Default: "None"

name

string / required

The name of the CustomFlow to be acted upon.

profile

string

If provided, the CDP SDK will use this value as its profile.

state

string

The declarative state of the CustomFlow

Choices:

  • "present" ← (default)

  • "absent"

verify_endpoint_tls

aliases: endpoint_tls

boolean

Verify the TLS certificates for the CDP endpoint.

Choices:

  • false

  • true ← (default)

Examples

# Import a CustomFlow into the DataFlow Catalog
- cloudera.cloud.df_customflow:
    name: my-customflow-name
    file: /tmp/my-custom-flow.json
    description: My sample CDF flow
    comments: Initial version

# Delete a CustomFlow from the DataFlow Catalog
- cloudera.cloud.df_customflow:
    name: my-customflow-name
    state: absent

Return Values

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

Key

Description

customflow

dictionary

The CustomFlow Definition

Returned: when supported

createdTimestamp

integer

The timestamp the entry was created.

Returned: always

crn

string

The DataFlow CustomFlow’s CRN.

Use this crn to address this object

Returned: always

modifiedTimestamp

integer

The timestamp the entry was last modified.

Returned: always

name

string

The DataFlow CustomFlow’s name.

Returned: always

versionCount

integer

Number of versions contained in this CustomFlow.

Returned: always

versions

list / elements=dictionary

The list of artifactDetail versions.

Returned: always

author

string

The author of the artifact.

Returned: always

bucketIdentifier

string

The bucketIdentifier of the flow.

Returned: always

crn

string

The artifact version CRN.

Returned: always

deploymentCount

integer

The number of deployments of the artifact.

Returned: always

timestamp

integer

The timestamp of the artifact.

Returned: always

version

integer

The version of the artifact.

Returned: always

Authors

  • Andre Araujo (@asdaraujo)