Google Native

v0.26.0 published on Friday, Sep 16, 2022 by Pulumi

InstanceGroup

Creates an instance group in the specified project using the parameters that are included in the request.

Create a InstanceGroup Resource

new InstanceGroup(name: string, args?: InstanceGroupArgs, opts?: CustomResourceOptions);
@overload
def InstanceGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  name: Optional[str] = None,
                  named_ports: Optional[Sequence[NamedPortArgs]] = None,
                  project: Optional[str] = None,
                  request_id: Optional[str] = None,
                  zone: Optional[str] = None)
@overload
def InstanceGroup(resource_name: str,
                  args: Optional[InstanceGroupArgs] = None,
                  opts: Optional[ResourceOptions] = None)
func NewInstanceGroup(ctx *Context, name string, args *InstanceGroupArgs, opts ...ResourceOption) (*InstanceGroup, error)
public InstanceGroup(string name, InstanceGroupArgs? args = null, CustomResourceOptions? opts = null)
public InstanceGroup(String name, InstanceGroupArgs args)
public InstanceGroup(String name, InstanceGroupArgs args, CustomResourceOptions options)
type: google-native:compute/alpha:InstanceGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args InstanceGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args InstanceGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args InstanceGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args InstanceGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args InstanceGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

InstanceGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The InstanceGroup resource accepts the following input properties:

Description string

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

Name string

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

NamedPorts List<Pulumi.GoogleNative.Compute.Alpha.Inputs.NamedPortArgs>

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.

Project string
RequestId string

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Zone string
Description string

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

Name string

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

NamedPorts []NamedPortArgs

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.

Project string
RequestId string

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Zone string
description String

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

name String

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

namedPorts List<NamedPortArgs>

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.

project String
requestId String

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

zone String
description string

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

name string

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

namedPorts NamedPortArgs[]

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.

project string
requestId string

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

zone string
description str

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

name str

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

named_ports Sequence[NamedPortArgs]

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.

project str
request_id str

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

zone str
description String

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

name String

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

namedPorts List<Property Map>

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.

project String
requestId String

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

zone String

Outputs

All input properties are implicitly available as output properties. Additionally, the InstanceGroup resource produces the following output properties:

CreationTimestamp string

The creation timestamp for this instance group in RFC3339 text format.

Fingerprint string

The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.

Id string

The provider-assigned unique ID for this managed resource.

Kind string

The resource type, which is always compute#instanceGroup for instance groups.

Network string

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

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

SelfLink string

The URL for this instance group. The server generates this URL.

SelfLinkWithId string

Server-defined URL for this resource with the resource id.

Size int

The total number of instances in the instance group.

Subnetwork string

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

CreationTimestamp string

The creation timestamp for this instance group in RFC3339 text format.

Fingerprint string

The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.

Id string

The provider-assigned unique ID for this managed resource.

Kind string

The resource type, which is always compute#instanceGroup for instance groups.

Network string

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

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

SelfLink string

The URL for this instance group. The server generates this URL.

SelfLinkWithId string

Server-defined URL for this resource with the resource id.

Size int

The total number of instances in the instance group.

Subnetwork string

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

creationTimestamp String

The creation timestamp for this instance group in RFC3339 text format.

fingerprint String

The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.

id String

The provider-assigned unique ID for this managed resource.

kind String

The resource type, which is always compute#instanceGroup for instance groups.

network String

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

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

selfLink String

The URL for this instance group. The server generates this URL.

selfLinkWithId String

Server-defined URL for this resource with the resource id.

size Integer

The total number of instances in the instance group.

subnetwork String

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

creationTimestamp string

The creation timestamp for this instance group in RFC3339 text format.

fingerprint string

The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.

id string

The provider-assigned unique ID for this managed resource.

kind string

The resource type, which is always compute#instanceGroup for instance groups.

network string

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

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

selfLink string

The URL for this instance group. The server generates this URL.

selfLinkWithId string

Server-defined URL for this resource with the resource id.

size number

The total number of instances in the instance group.

subnetwork string

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

creation_timestamp str

The creation timestamp for this instance group in RFC3339 text format.

fingerprint str

The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.

id str

The provider-assigned unique ID for this managed resource.

kind str

The resource type, which is always compute#instanceGroup for instance groups.

network str

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 str

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

self_link str

The URL for this instance group. The server generates this URL.

self_link_with_id str

Server-defined URL for this resource with the resource id.

size int

The total number of instances in the instance group.

subnetwork str

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

creationTimestamp String

The creation timestamp for this instance group in RFC3339 text format.

fingerprint String

The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.

id String

The provider-assigned unique ID for this managed resource.

kind String

The resource type, which is always compute#instanceGroup for instance groups.

network String

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

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

selfLink String

The URL for this instance group. The server generates this URL.

selfLinkWithId String

Server-defined URL for this resource with the resource id.

size Number

The total number of instances in the instance group.

subnetwork String

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

Supporting Types

NamedPort

Name string

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

Port int

The port number, which can be a value between 1 and 65535.

Name string

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

Port int

The port number, which can be a value between 1 and 65535.

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.

name string

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

port number

The port number, which can be a value between 1 and 65535.

name str

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

port int

The port number, which can be a value between 1 and 65535.

name String

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

port Number

The port number, which can be a value between 1 and 65535.

NamedPortResponse

Name string

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

Port int

The port number, which can be a value between 1 and 65535.

Name string

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

Port int

The port number, which can be a value between 1 and 65535.

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.

name string

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

port number

The port number, which can be a value between 1 and 65535.

name str

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

port int

The port number, which can be a value between 1 and 65535.

name String

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

port Number

The port number, which can be a value between 1 and 65535.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0