Parameter |
Choices/Defaults |
Comments |
auth_kind
string
/ required
|
Choices:
- application
- machineaccount
- serviceaccount
|
The type of credential used.
|
description
string
|
|
An optional description of this resource. Provide this property when you create the resource.
|
env_type
string
|
|
Specifies which Ansible environment you're running this module within.
This should not be set unless you know what you're doing.
This only alters the User Agent string for any API requests.
|
instances
list
/ elements=dictionary
|
|
The list of instances associated with this InstanceGroup.
All instances must be created before being added to an InstanceGroup.
All instances not in this list will be removed from the InstanceGroup and will not be deleted.
Only the full identifier of the instance will be returned.
|
name
string
|
|
The name of the instance group.
The name must be 1-63 characters long, and comply with RFC1035.
|
named_ports
list
/ elements=dictionary
|
|
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: "http", port: 80},{name: "http", port: 8080}] Named ports apply to all instances in this instance group.
|
|
name
string
|
|
The name for this named port.
The name must be 1-63 characters long, and comply with RFC1035.
|
|
port
integer
|
|
The port number, which can be a value between 1 and 65535.
|
network
dictionary
|
|
The network to which all instances in the instance group belong.
This field represents a link to a Network resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_network task and then set this network field to "{{ name-of-resource }}"
|
project
string
|
|
The Google Cloud Platform project to use.
|
region
string
|
|
The region where the instance group is located (for regional resources).
|
scopes
list
/ elements=string
|
|
Array of scopes to be used
|
service_account_contents
jsonarg
|
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
|
service_account_email
string
|
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
|
service_account_file
path
|
|
The path of a Service Account JSON file if serviceaccount is selected as type.
|
state
string
|
Choices:
present ←
- absent
|
Whether the given object should exist in GCP
|
subnetwork
dictionary
|
|
The subnetwork to which all instances in the instance group belong.
This field represents a link to a Subnetwork resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_subnetwork task and then set this subnetwork field to "{{ name-of-resource }}"
|
zone
string
/ required
|
|
A reference to the zone where the instance group resides.
|