cloudera.services.atlas_enum_def module – Manage enum type definitions in Apache Atlas

Note

This module is part of the cloudera.services collection (version 1.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 git+https://github.com/cloudera-labs/cloudera.services.git.

To use it in a playbook, specify: cloudera.services.atlas_enum_def.

New in cloudera.services 1.1.0

Synopsis

  • Create, update, or delete enum type definitions in Apache Atlas.

Parameters

Parameter

Comments

client_cert

path

The path to a client certificate for authenticating to the API endpoint.

client_key

path

The path to a client key for authenticating to the API endpoint.

debug

aliases: debug_endpoints

boolean

A flag to enable debug logging of the module’s execution.

Choices:

  • false ← (default)

  • true

default_value

string

Value of the element used as the default.

description

string

Description of the enum type definition.

element_defs

list / elements=dictionary

Elements of the enum.

Replaces the existing elements; Atlas may reject removing elements that are in use.

description

string

Description of the element.

ordinal

integer

Position of the element. Assigned by Atlas when omitted.

value

string / required

Value of the element.

force

boolean

A flag to force a refresh of the API request, ignoring any cached results.

Choices:

  • false ← (default)

  • true

force_basic_auth

boolean

A flag to force basic authentication for API requests.

Choices:

  • false ← (default)

  • true

http_agent

aliases: user_agent

string

The User-Agent string to send with API requests.

Default: "cloudera-services-module"

name

string

Name of the enum type definition.

Required when state=present or state=absent.

options

dictionary

Free-form map of string options for the type definition.

Keys are sent to Atlas verbatim.

page_size

aliases: default_page_size

integer

The number of items to return per page in a paginated API response.

Default: 100

service_type

string

Name of the service that owns the type definition.

state

string

Whether the enum type definition should be present or absent.

Choices:

  • "present" ← (default)

  • "absent"

timeout

aliases: timeout_seconds

integer

The timeout in seconds for any API requests.

Default: 60

type_version

string

Version label of the type definition, e.g. 1.0.

url

aliases: endpoint, endpoint_url

string / required

The base URL of the API endpoint, including the port if necessary.

url_password

string

The password for authenticating to the API endpoint.

url_username

string

The username for authenticating to the API endpoint.

use_gssapi

boolean

A flag to enable or disable GSSAPI authentication for API requests.

Choices:

  • false ← (default)

  • true

use_proxy

boolean

A flag to enable or disable the use of a proxy for API requests.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

A flag to enable or disable SSL certificate validation for API requests.

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

This module supports check mode.

diff_mode

Support: full

This module supports diff mode.

Examples

# NOTE: Examples do not include connection and authentication fields
- name: Create an enum type definition
  cloudera.services.atlas_enum_def:
    name: traffic_light
    description: Traffic light colors
    element_defs:
      - value: RED
      - value: GREEN

- name: Remove an enum type definition
  cloudera.services.atlas_enum_def:
    name: traffic_light
    state: absent

Return Values

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

Key

Description

enum_def

dictionary

The enum type definition.

Returned: when state=present

category

string

Type category, always ENUM.

Returned: success

create_time

integer

Creation time in epoch milliseconds.

Returned: success

created_by

string

User that created the type definition.

Returned: success

default_value

string

Value of the default element.

Returned: success

description

string

Description of the enum type definition.

Returned: success

element_defs

list / elements=dictionary

Elements of the enum.

Returned: success

description

string

Description of the element.

Returned: success

ordinal

integer

Position of the element.

Returned: success

value

string

Value of the element.

Returned: success

guid

string

Atlas-assigned identifier.

Returned: success

name

string

Name of the enum type definition.

Returned: success

options

dictionary

Free-form options of the type definition.

Returned: success

service_type

string

Name of the service that owns the type definition.

Returned: success

type_version

string

Version label of the type definition.

Returned: success

update_time

integer

Last update time in epoch milliseconds.

Returned: success

updated_by

string

User that last updated the type definition.

Returned: success

version

integer

Atlas version number of the type definition.

Returned: success

Authors

  • Webster Mudge (@wmudge)