google.cloud.gcp_alloydb_user module – Creates a GCP Alloydb.User resource

Note

This module is part of the google.cloud collection (version 1.10.2).

You might already have this collection installed if you are using the ansible package. 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 google.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: google.cloud.gcp_alloydb_user.

Synopsis

  • A database user in an AlloyDB cluster.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.8

  • requests >= 2.18.4

  • google-auth >= 2.25.1

Parameters

Parameter

Comments

access_token

string

The access token used to authenticate.

auth_kind

string / required

The type of credential used.

Choices:

  • "accesstoken"

  • "application"

  • "machineaccount"

  • "serviceaccount"

cluster

dictionary / required

Identifies the alloydb cluster.

Must be in the format ‘projects/{project}/locations/{location}/clusters/{cluster_id}’.

This field is a reference to a Cluster resource in GCP.

It can be specified in two ways: First, you can place a dictionary with key ‘name’ matching your resource.

Alternatively, you can add `register: name-of-resource` to a Cluster task and then set this field to `{{ name-of-resource }}`.

database_roles

list / elements=string

List of database roles this database user has.

env_type

string

Specifies which Ansible environment you’re running this module within.

This should not be set unless you know what you’re doing.

This only alters the User Agent string for any API requests.

password

string

Password for this database user.

project

string

The Google Cloud Platform project to use.

scopes

list / elements=string

Array of scopes to be used.

service_account_contents

jsonarg

The contents of a Service Account JSON file,

either in a dictionary or as a JSON string that represents it.

service_account_email

string

An optional service account email address if machineaccount is

selected and the user does not wish to use the default email.

service_account_file

path

The path of a Service Account JSON file if serviceaccount

is selected as type.

state

string

Whether the resource should exist in GCP.

Choices:

  • "present" ← (default)

  • "absent"

user_id

string / required

The database role name of the user.

user_type

string / required

The type of this user.

Choices:

  • "ALLOYDB_BUILT_IN"

  • "ALLOYDB_IAM_USER"

Notes

Note

Examples

- name: Create user for cluster
  google.cloud.gcp_alloydb_user:
    user_id: superuser
    state: present
    user_type: ALLOYDB_BUILT_IN
    password: Test123Test
    database_roles:
      - alloydbsuperuser
    cluster:
      name: projects/my-project/locations/us-central1/clusters/my-cluster

Return Values

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

Key

Description

changed

boolean

Whether the resource was changed.

Returned: always

name

string

Name of the resource in the form of projects/{project}/locations/{location}/clusters/{cluster}/users/{user}.

Returned: success

state

string

The current state of the resource.

Returned: always

Authors

  • Google Inc. (@googlecloudplatform)