cloudera.cloud.dw_data_visualization module – Create or Delete CDP Data Visualization Instance

Note

This module is part of the cloudera.cloud collection (version 3.0.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. You need further requirements to be able to use this module, see Requirements for details.

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

New in cloudera.cloud 2.0.0

Synopsis

  • Create or Delete CDP Data Visualization Instance

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"

cluster_id

string

The identifier of the Data Warehouse Cluster.

Mutually exclusive with environment.

config

dictionary

User and Admin groups that can access the Data Visualization Instance.

userGroups: List of user groups that have access to the instance. Example: [‘group1’, ‘group2’]

adminGroups: List of admin groups that have full control over the instance. Example: [‘admin_group1’, ‘admin_group2’]

adminGroups

list / elements=string

List of admin groups that have full control over the Data Visualization Instance.

Must be a list of strings, e.g., [‘admin_group1’, ‘admin_group2’].

resourcePool

string

The Resource Pool of the Cloudera Data Visualization.

userGroups

list / elements=string

List of user groups that have access to the Data Visualization Instance.

Must be a list of strings, e.g., [‘group1’, ‘group2’].

debug

aliases: debug_endpoints

boolean

Capture the CDP SDK debug log.

Choices:

  • false ← (default)

  • true

delay

aliases: polling_delay

integer

The internal polling interval (in seconds) while the module waits for the Data Visualization Instance to achieve the declared state.

Default: 15

environment

aliases: env, env_crn

string

The name of the target environment.

Mutually exclusive with cluster_id.

image_version

string

Version of the Cloudera Data Visualization.

name

string

The name of the Data Visualization Instance.

This name must be unique, must have between 5 and 20 characters, and must contain only lowercase letters, numbers, and hyphens.

profile

string

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

resource_template

aliases: template_name

string

The name of the available resource template to use for the Cloudera Data Visualization.

state

string

The state of the Data Visualization Instance

Choices:

  • "present" ← (default)

  • "absent"

timeout

aliases: polling_timeout

integer

The internal polling timeout (in seconds) while the module waits for the Data Visualization Instance to achieve the declared state.

Default: 3600

verify_endpoint_tls

aliases: endpoint_tls

boolean

Verify the TLS certificates for the CDP endpoint.

Choices:

  • false

  • true ← (default)

wait

boolean

Flag to enable internal polling to wait for the Data Visualization Instance to achieve the declared state.

If set to FALSE, the module will return immediately.

Choices:

  • false

  • true ← (default)

Examples

# Note: These examples do not set authentication details.

# Create Data Visualization Instance
- cloudera.cloud.dw_data_visualization:
    environment: example-env
    name: example-name
    config:
      userGroups: "[ example_user_group ]"
      adminGroups: "[ example_admin_group ]"
    state: present

# Delete Data Visualization Instance
- cloudera.cloud.dw_data_visualization:
    environment: example-env
    name: example-name
    state: absent

Return Values

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

Key

Description

cluster

dictionary

Details for the Data Visualization Instance

Returned: success

creatorCrn

string

The CRN of the creator of the Data Visualization Instance.

Returned: always

id

string

The unique id of the Data Visualization instance

Returned: always

imageVersion

string

The current version of Data Visualization

Returned: always

name

string

The name of the Data Visualization instance

Returned: always

size

string

The size of the Data Visualization instance

Returned: always

status

string

The status of the Data Visualization instance

Returned: always

sdk_out

string

Returns the captured CDP SDK log.

Returned: when supported

sdk_out_lines

list / elements=string

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

Returned: when supported

Authors

  • Dan Chaffelson (@chaffelson)

  • Saravanan Raju (@raju-saravanan)

  • Webster Mudge (@wmudge)

  • Ronald Suplina (@rsuplina)