cloudera.cloud.account_cred_info module – Gather information about Account prerequisites for CDP Credentials

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

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

New in cloudera.cloud 1.0.0

Synopsis

  • Gather prerequisites information from the Account for creating CDP Credentials using the CDP SDK.

  • The module supports check_mode.

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"

cloud

string / required

Designates the cloud provider for the credential prerequisites.

Choices:

  • "aws"

  • "azure"

debug

aliases: debug_endpoints

boolean

Capture the CDP SDK debug log.

Choices:

  • false ← (default)

  • true

profile

string

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

verify_endpoint_tls

aliases: endpoint_tls

boolean

Verify the TLS certificates for the CDP endpoint.

Choices:

  • false

  • true ← (default)

Examples

# Note: These examples do not set authentication details.

# Gather information about the AWS account credential prerequisites
- cloudera.cloud.account_cred_info:
    cloud: aws

Return Values

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

Key

Description

prerequisites

dictionary

Returns a dictionary of the specific cloud provider prerequisites for Credentials

Returned: always

account_id

string

The account identifier for the CDP installation.

Returned: always

Sample: "3875500000000"

external_id

string

The AWS cross-account identifier for the CDP installation.

Returned: when supported

Sample: "32b18f82-f868-414f-aedc-b3ee137560e3"

policy

string

The policy definition, returned as a base64 string.

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

  • Webster Mudge (@wmudge)

  • Dan Chaffelson (@chaffelson)