confluent.cloud.environment (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

Manage Confluent Cloud Environments

Usage examples

Scanned by Steampunk Spotter

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

- name: Create new environment
  confluent.cloud.environment:
    name: test_env
    state: present

Scanned by Steampunk Spotter

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

- name: Delete existing environment by name
  confluent.cloud.environment:
    name: test_env
    state: absent

Scanned by Steampunk Spotter

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

- name: Modify existing environment by Id
  confluent.cloud.environment:
    id: env-dsh38dja
    name: test_env_new
    state: present

Inputs

    
id:
    description: Environment Id
    type: str

name:
    description:
    - Environment name.
    - Mutation after creation requires supplying the environment id.
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - If `absent`, the environment and all objects (clusters, service accounts) will be
      removed. Note that absent will not cause Environment to fail if the Environment
      does not exist.
    - If `present`, the environment will be created.
    type: str

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

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