google.cloud.gcp_iam_role module – Creates a GCP Role
Note
This module is part of the google.cloud collection (version 1.4.1).
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_iam_role
.
Note
The google.cloud collection will be removed from Ansible 12 due to violations of the Ansible inclusion requirements. The collection has unresolved sanity test failures. See the discussion thread for more information.
Synopsis
A role in the Identity and Access Management API .
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0
Parameters
Parameter |
Comments |
---|---|
An OAuth2 access token if credential type is accesstoken. |
|
The type of credential used. Choices:
|
|
Human-readable description for the role. |
|
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. |
|
Names of permissions this role grants when bound in an IAM policy. |
|
The name of the role. |
|
The Google Cloud Platform project to use. |
|
Array of scopes to be used |
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. |
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email. |
|
The path of a Service Account JSON file if serviceaccount is selected as type. |
|
The current launch stage of the role. Some valid choices include: “ALPHA”, “BETA”, “GA”, “DEPRECATED”, “DISABLED”, “EAP” |
|
Whether the given object should exist in GCP Choices:
|
|
A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes. |
Examples
- name: create a role
google.cloud.gcp_iam_role:
name: myCustomRole2
title: My Custom Role
description: My custom role description
included_permissions:
- iam.roles.list
- iam.roles.create
- iam.roles.delete
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The current deleted state of the role. Returned: success |
|
Human-readable description for the role. Returned: success |
|
Names of permissions this role grants when bound in an IAM policy. Returned: success |
|
The name of the role. Returned: success |
|
The current launch stage of the role. Returned: success |
|
A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes. Returned: success |