instance_groups

Creates, updates, deletes, gets or lists a instance_groups resource.

Overview

Name	instance_groups
Type	Resource
Id	google.compute.instance_groups

Fields

Name	Datatype	Description
id	string	[Output Only] A unique identifier for this instance group, generated by the server.
name	string	The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
description	string	An optional description of this resource. Provide this property when you create the resource.
creationTimestamp	string	[Output Only] The creation timestamp for this instance group in RFC3339 text format.
fingerprint	string	[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
kind	string	[Output Only] The resource type, which is always compute#instanceGroup for instance groups.
namedPorts	array	Assigns a name to a port number. For example: {name: "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: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group.
network	string	[Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
region	string	[Output Only] The URL of the region where the instance group is located (for regional resources).
selfLink	string	[Output Only] The URL for this instance group. The server generates this URL.
size	integer	[Output Only] The total number of instances in the instance group.
subnetwork	string	[Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
zone	string	[Output Only] The URL of the zone where the instance group is located (for zonal resources).

Methods

Name	Accessible by	Required Params	Description
aggregated_list	SELECT	project	Retrieves the list of instance groups and sorts them by zone. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
get	SELECT	instanceGroup, project, zone	Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
list	SELECT	project, zone	Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
insert	INSERT	project, zone	Creates an instance group in the specified project using the parameters that are included in the request.
delete	DELETE	instanceGroup, project, zone	Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.
set_named_ports	EXEC	instanceGroup, project, zone	Sets the named ports for the specified instance group.

SELECT examples

Retrieves the list of instance groups and sorts them by zone. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

SELECT
id,
name,
description,
creationTimestamp,
fingerprint,
kind,
namedPorts,
network,
region,
selfLink,
size,
subnetwork,
zone
FROM google.compute.instance_groups
WHERE project = '{{ project }}';

INSERT example

Use the following StackQL query and manifest file to create a new instance_groups resource.

All Properties

/*+ create */
INSERT INTO google.compute.instance_groups (
project,
zone,
name,
description,
namedPorts,
network,
fingerprint,
zone,
size,
region,
subnetwork
)
SELECT 
'{{ project }}',
'{{ zone }}',
'{{ name }}',
'{{ description }}',
'{{ namedPorts }}',
'{{ network }}',
'{{ fingerprint }}',
'{{ zone }}',
'{{ size }}',
'{{ region }}',
'{{ subnetwork }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: namedPorts
      value:
        - - name: name
            value: string
          - name: port
            value: integer
    - name: network
      value: string
    - name: fingerprint
      value: string
    - name: zone
      value: string
    - name: selfLink
      value: string
    - name: size
      value: integer
    - name: region
      value: string
    - name: subnetwork
      value: string

DELETE example

Deletes the specified instance_groups resource.

/*+ delete */
DELETE FROM google.compute.instance_groups
WHERE instanceGroup = '{{ instanceGroup }}'
AND project = '{{ project }}'
AND zone = '{{ zone }}';