google.cloud.gcp_iam_role module – Creates a GCP Role

Note

This module is part of the google.cloud collection (version 1.0.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.

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

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

auth_kind

string / required

The type of credential used.

Choices:

  • application

  • machineaccount

  • serviceaccount

description

string

Human-readable description for the role.

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.

included_permissions

list / elements=string

Names of permissions this role grants when bound in an IAM policy.

name

string / required

The name of the role.

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.

stage

string

The current launch stage of the role.

Some valid choices include: “ALPHA”, “BETA”, “GA”, “DEPRECATED”, “DISABLED”, “EAP”

state

string

Whether the given object should exist in GCP

Choices:

  • present ← (default)

  • absent

title

string

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

deleted

boolean

The current deleted state of the role.

Returned: success

description

string

Human-readable description for the role.

Returned: success

includedPermissions

list / elements=string

Names of permissions this role grants when bound in an IAM policy.

Returned: success

name

string

The name of the role.

Returned: success

stage

string

The current launch stage of the role.

Returned: success

title

string

A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.

Returned: success

Authors

  • Google Inc. (@googlecloudplatform)