Class: Ansible::Ruby::Modules::Gcp_compute_instance_group_manager

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

Overview

Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances. A managed instance group can have up to 1000 VM instances per group.

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

#base_instance_name ⇒ String

Returns The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name.,The base instance name must comply with RFC1035.

Returns:

  • (String) —

    The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name.,The base instance name must comply with RFC1035.



17
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_instance_group_manager.rb', line 17

attribute :base_instance_name

#description ⇒ Object?

Returns An optional description of this resource. Provide this property when you create the resource.

Returns:

  • (Object, nil) —

    An optional description of this resource. Provide this property when you create the resource.



21
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_instance_group_manager.rb', line 21

attribute :description

#instance_template ⇒ String

Returns The instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.

Returns:

  • (String) —

    The instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_instance_group_manager.rb', line 24

attribute :instance_template

#name ⇒ String

Returns The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

Returns:

  • (String) —

    The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.



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

attribute :name

#named_ports ⇒ Object?

Returns Named ports configured for the Instance Groups complementary to this Instance Group Manager.

Returns:

  • (Object, nil) —

    Named ports configured for the Instance Groups complementary to this Instance Group Manager.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_instance_group_manager.rb', line 32

attribute :named_ports

#state ⇒ :present, ...

Returns Whether the given object should exist in GCP.

Returns:

  • (:present, :absent, nil) —

    Whether the given object should exist in GCP



13
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_instance_group_manager.rb', line 13

attribute :state

#target_pools ⇒ Object?

Returns TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

Returns:

  • (Object, nil) —

    TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.



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

attribute :target_pools

#target_size ⇒ Integer?

Returns The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.

Returns:

  • (Integer, nil) —

    The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.



38
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_instance_group_manager.rb', line 38

attribute :target_size

#zone ⇒ String

Returns The zone the managed instance group resides.

Returns:

  • (String) —

    The zone the managed instance group resides.



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

attribute :zone