Class: Ansible::Ruby::Modules::Heroku_collaborator

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/heroku/heroku_collaborator.rb

Overview

Manages collaborators for Heroku apps. If set to C(present) and heroku user is already collaborator, then do nothing. If set to C(present) and heroku user is not collaborator, then add user to app. If set to C(absent) and heroku user is collaborator, then delete user from app.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#api_key ⇒ String?

Returns Heroku API key.

Returns:

  • (String, nil) —

    Heroku API key



15
 
# File 'lib/ansible/ruby/modules/generated/cloud/heroku/heroku_collaborator.rb', line 15

attribute :api_key

#apps ⇒ Array<String>, String

Returns List of Heroku App names.

Returns:

  • (Array<String>, String) —

    List of Heroku App names



19
 
# File 'lib/ansible/ruby/modules/generated/cloud/heroku/heroku_collaborator.rb', line 19

attribute :apps

#state ⇒ :present, ...

Returns Create or remove the heroku collaborator.

Returns:

  • (:present, :absent, nil) —

    Create or remove the heroku collaborator



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/heroku/heroku_collaborator.rb', line 31

attribute :state

#suppress_invitation ⇒ :yes, ...

Returns Suppress email invitation when creating collaborator.

Returns:

  • (:yes, :no, nil) —

    Suppress email invitation when creating collaborator



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/heroku/heroku_collaborator.rb', line 23

attribute :suppress_invitation

#user ⇒ String

Returns User ID or e-mail.

Returns:

  • (String) —

    User ID or e-mail



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/heroku/heroku_collaborator.rb', line 27

attribute :user