Class: Ansible::Ruby::Modules::Gcp_compute_instance_group

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

Overview

Represents an Instance Group resource. Instance groups are self-managed and can contain identical or different instances. Instance groups do not use an instance template. Unlike managed instance groups, you must create and add instances to an instance group manually.

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

#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.



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

attribute :description

#name ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :name

#named_ports ⇒ Array<Hash>, ...

Returns Assigns a name to a port number.,For example: “http”, port: 80.,This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports.,For example: [“http”, port: 80,“http”, port: 8080] Named ports apply to all instances in this instance group.

Returns:

  • (Array<Hash>, Hash, nil) —

    Assigns a name to a port number.,For example: “http”, port: 80.,This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports.,For example: [“http”, port: 80,“http”, port: 8080] Named ports apply to all instances in this instance group.



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_instance_group.rb', line 23

attribute :named_ports

#network ⇒ String?

Returns The network to which all instances in the instance group belong.

Returns:

  • (String, nil) —

    The network to which all instances in the instance group belong.



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_instance_group.rb', line 27

attribute :network

#region ⇒ Object?

Returns The region where the instance group is located (for regional resources).

Returns:

  • (Object, nil) —

    The region where the instance group is located (for regional resources).



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

attribute :region

#state ⇒ :present, ...

Returns Whether the given object should exist in GCP.

Returns:

  • (:present, :absent, nil) —

    Whether the given object should exist in GCP



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

attribute :state

#subnetwork ⇒ Object?

Returns The subnetwork to which all instances in the instance group belong.

Returns:

  • (Object, nil) —

    The subnetwork to which all instances in the instance group belong.



34
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_instance_group.rb', line 34

attribute :subnetwork

#zone ⇒ String

Returns A reference to the zone where the instance group resides.

Returns:

  • (String) —

    A reference to the zone where the instance group resides.



37
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_instance_group.rb', line 37

attribute :zone