cloudera.cloud.dw_secret_info module – Gather information about CDP Data Warehouse secrets

Note

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

New in cloudera.cloud 3.4.0

Synopsis

  • Gather information about CDW (Cloudera Data Warehouse) secrets in a cluster.

  • Optionally filter by secret name (exact match).

  • The module supports check_mode.

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.

cluster_id

aliases: id

string / required

The ID of the CDW cluster.

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"

name

aliases: secret_name

string

The name of the secret to retrieve.

Filters results to the secret whose secretName exactly matches this value.

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"

strict

aliases: strict_errors

boolean

Legacy CDPy SDK error handling.

Choices:

  • false ← (default)

  • true

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped.

diff_mode

Support: N/A

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

platform

Platforms: all

Target OS/families that can be operated against

Examples

- name: List all secrets in a CDW cluster
  cloudera.cloud.dw_secret_info:
    cluster_id: "env-abc123"

- name: Retrieve a specific secret by name
  cloudera.cloud.dw_secret_info:
    cluster_id: "env-abc123"
    name: "my-secret"

- name: List secrets using cluster ID alias
  cloudera.cloud.dw_secret_info:
    id: "env-abc123"
    secret_name: "my-db-password"

Return Values

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

Key

Description

sdk_out

string

Returns the captured CDP SDK log.

Returned: when debug is true

sdk_out_lines

list / elements=string

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

Returned: when debug is true

secrets

list / elements=dictionary

A list of CDW secrets.

Returned: always

createdBy

string

The CRN of the user who created the secret.

Returned: when available

properties

dictionary

The properties of the secret.

Returned: when available

azureVaultName

string

The name of the Azure Key Vault.

Returned: when available

cloudProvider

string

The cloud provider associated with the secret.

Returned: when available

version

string

The version of the secret.

Returned: when available

secretName

string

The user-facing name of the secret.

Returned: when available

secretProviderKey

string

The provider key name associated with the secret.

Returned: when available

Authors

  • Webster Mudge (@wmudge)