Class: Ansible::Ruby::Modules::Gce_mig

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

Overview

Create, Update or Destroy a Managed Instance Group (MIG). See U(cloud.google.com/compute/docs/instance-groups) for an overview. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.

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

#autoscaling ⇒ Object?

Returns A dictionary of configuration for the autoscaler. ‘enabled (bool)’, ‘name (str)’ and policy.max_instances (int) are required fields if autoscaling is used. See U(cloud.google.com/compute/docs/reference/beta/autoscalers) for more information on Autoscaling.

Returns:

  • (Object, nil) —

    A dictionary of configuration for the autoscaler. ‘enabled (bool)’, ‘name (str)’ and policy.max_instances (int) are required fields if autoscaling is used. See U(cloud.google.com/compute/docs/reference/beta/autoscalers) for more information on Autoscaling.



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_mig.rb', line 39

attribute :autoscaling

#credentials_file ⇒ Object?

Returns Path to the JSON file associated with the service account email.

Returns:

  • (Object, nil) —

    Path to the JSON file associated with the service account email



25
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_mig.rb', line 25

attribute :credentials_file

#name ⇒ String

Returns Name of the Managed Instance Group.

Returns:

  • (String) —

    Name of the Managed Instance Group.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_mig.rb', line 12

attribute :name

#named_ports ⇒ Object?

Returns Define named ports that backend services can forward data to. Format is a a list of name:port dictionaries.

Returns:

  • (Object, nil) —

    Define named ports that backend services can forward data to. Format is a a list of name:port dictionaries.



42
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_mig.rb', line 42

attribute :named_ports

#project_id ⇒ Object?

Returns GCE project ID.

Returns:

  • (Object, nil) —

    GCE project ID



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_mig.rb', line 28

attribute :project_id

#service_account_email ⇒ Object?

Returns service account email.

Returns:

  • (Object, nil) —

    service account email



22
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_mig.rb', line 22

attribute :service_account_email

#size ⇒ Object?

Returns Size of Managed Instance Group. If MIG already exists, it will be resized to the number provided here. Required for creating MIGs.

Returns:

  • (Object, nil) —

    Size of Managed Instance Group. If MIG already exists, it will be resized to the number provided here. Required for creating MIGs.



19
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_mig.rb', line 19

attribute :size

#state ⇒ :absent, ...

Returns desired state of the resource.

Returns:

  • (:absent, :present, nil) —

    desired state of the resource



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_mig.rb', line 31

attribute :state

#template ⇒ Object?

Returns Instance Template to be used in creating the VMs. See U(cloud.google.com/compute/docs/instance-templates) to learn more about Instance Templates. Required for creating MIGs.

Returns:



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_mig.rb', line 16

attribute :template

#zone ⇒ Object

Returns The GCE zone to use for this Managed Instance Group.

Returns:

  • (Object) —

    The GCE zone to use for this Managed Instance Group.



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_mig.rb', line 35

attribute :zone