confluent.cloud.service_account (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 existing Confluent Cloud service_accounts within a Confluent Cloud environment.

Note this is different than service_accounts which uses its own module.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create new service account
  confluent.cloud.service account:
    name: application_1
    description: Service account for application 1
    state: present

Scanned by Steampunk Spotter

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

- name: Modify service account
  confluent.cloud.service account:
    id: sa-j31z28
    name: application_new_name
    state: present

Scanned by Steampunk Spotter

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

- name: Delete service account (by id)
  confluent.cloud.service_account:
    id: sa-j31z28
    state: absent

Scanned by Steampunk Spotter

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

- name: Delete service account (by name)
  confluent.cloud.service_account:
    name: application_1
    state: absent

Inputs

    
id:
    description: Service Account Id
    type: str

name:
    description:
    - A human-readable name for the Service Account
    - Cannot be changed after creation
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - If `absent`, the service account will be removed. Note that absent will not cause
      Service Account to fail if the Service Account does not exist.
    - If `present`, the service account 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

description:
    description:
    - A free-form description of the Service Account
    type: str

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

description:
  description: A free-form description of the Service Account
  returned: success
  sample: Service account for Application 1
  type: str
id:
  description: Service account id
  returned: success
  sample: sa-lz51vz
  type: str
metadata:
  description: User metadata, including create timestamp and updated timestamp
  returned: success
  type: dict
name:
  description: A human-readable name for the Service Account
  returned: success
  sample: application_1
  type: str