cloudera.cloud.df_customflow_version module – Import CustomFlow versions 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_version.

Synopsis

  • Import CustomFlow versions 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 version of the CustomFlow being imported.

Default: "None"

debug

aliases: debug_endpoints

boolean

Capture the CDP SDK debug log.

Choices:

  • false ← (default)

  • true

file

string / required

The JSON file containing the CustomFlow definition to be imported as a new version.

flow_crn

string / required

The name of the CustomFlow into which the version will be imported.

profile

string

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

state

string

The declarative state of the CustomerFlow version

Choices:

  • "present" ← (default)

verify_endpoint_tls

aliases: endpoint_tls

boolean

Verify the TLS certificates for the CDP endpoint.

Choices:

  • false

  • true ← (default)

Examples

# Import a CustomFlow version into the DataFlow Catalog
- cloudera.cloud.df_customflow_version:
    name: my-customflow-version-name
    file: /tmp/my-custom-flow-v2.json
    comments: Second version

Return Values

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

Key

Description

customflow_version

dictionary

The CustomFlow Version Definition

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)