confluent.cloud.environment_info (0.1.0) — module

Install collection

Install with ansible-galaxy collection install confluent.cloud:==0.1.0

Add to requirements.yml

  collections:
    - name: confluent.cloud
      version: 0.1.0

Description

Enumerate and filter environments within Confluent Cloud.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: List all available environments
  confluent.cloud.environment_info:

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: List environments that match the given Ids
  confluent.cloud.environment_info:
    ids:
      - env-f3a90de
      - env-3887de0

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: List environments that match the given Names
  confluent.cloud.environment_info:
    names:
      - Test
      - Production

Inputs

    
ids:
    description:
    - List of environment Ids.
    - Mutually exclusive when used with `names`
    elements: str
    type: list

names:
    description:
    - List of environment Names.
    - Mutually exclusive when used with `ids`
    elements: str
    type: list

api_key:
    description: Confluent Cloud API Key
    required: true
    type: str

api_secret:
    description: Confluent Cloud API Secret
    required: true
    type: str

api_retries:
    default: 5
    description: Amount of max retries for the API requests.
    type: int

api_timeout:
    default: 60
    description: Timeout used for the API requests.
    type: int

api_endpoint:
    default: https://api.confluent.cloud
    description: Endpoint used for the API requests.
    type: str

validate_certs:
    default: true
    description: Whether to vaidate API endpoint TLS certs
    type: bool

api_retry_max_delay:
    default: 12
    description: Exponential backoff delay in seconds between retries up to this max delay
      value.
    type: int

Outputs

environments:
  contains:
    display_name:
      description: Environment name
      returned: success
      type: str
    id:
      description: Environment id
      returned: success
      sample: env-9v5v5
      type: str
    metadata:
      description: Environment metadata, including create timestamp and updated timestamp
      returned: success
      type: dict
    resource_uri:
      description: Globally unique URI for resource
      returned: success
      sample: crn://confluent.cloud/organization=6830dbfe-5057-4e65-ae2e-f6a090640ec0/environment=env-nvm8yz
      type: str
  description: Dictionary of matching envrionments, keyed by environment id
  returned: success
  type: dict