Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. compute
  5. compute/v1
  6. getInstanceGroup

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.compute/v1.getInstanceGroup

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    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.

    Using getInstanceGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getInstanceGroup(args: GetInstanceGroupArgs, opts?: InvokeOptions): Promise<GetInstanceGroupResult>
function getInstanceGroupOutput(args: GetInstanceGroupOutputArgs, opts?: InvokeOptions): Output<GetInstanceGroupResult>
    def get_instance_group(instance_group: Optional[str] = None,
                       project: Optional[str] = None,
                       zone: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetInstanceGroupResult
def get_instance_group_output(instance_group: Optional[pulumi.Input[str]] = None,
                       project: Optional[pulumi.Input[str]] = None,
                       zone: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetInstanceGroupResult]
    func LookupInstanceGroup(ctx *Context, args *LookupInstanceGroupArgs, opts ...InvokeOption) (*LookupInstanceGroupResult, error)
func LookupInstanceGroupOutput(ctx *Context, args *LookupInstanceGroupOutputArgs, opts ...InvokeOption) LookupInstanceGroupResultOutput

    > Note: This function is named LookupInstanceGroup in the Go SDK.

    public static class GetInstanceGroup 
{
    public static Task<GetInstanceGroupResult> InvokeAsync(GetInstanceGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceGroupResult> Invoke(GetInstanceGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInstanceGroupResult> getInstanceGroup(GetInstanceGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:compute/v1:getInstanceGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceGroup string
    Zone string
    Project string
    InstanceGroup string
    Zone string
    Project string
    instanceGroup String
    zone String
    project String
    instanceGroup string
    zone string
    project string
    instanceGroup String
    zone String
    project String

    getInstanceGroup Result

    The following output properties are available:

    CreationTimestamp string
    The creation timestamp for this instance group in RFC3339 text format.
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    Fingerprint string
    The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
    Kind string
    The resource type, which is always compute#instanceGroup for instance groups.
    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.V1.Outputs.NamedPortResponse>
    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
    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.
    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).
    Zone string
    The URL of the zone where the instance group is located (for zonal resources).
    CreationTimestamp string
    The creation timestamp for this instance group in RFC3339 text format.
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    Fingerprint string
    The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
    Kind string
    The resource type, which is always compute#instanceGroup for instance groups.
    Name string
    The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
    NamedPorts []NamedPortResponse
    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
    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.
    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).
    Zone string
    The URL of the zone where the instance group is located (for zonal resources).
    creationTimestamp String
    The creation timestamp for this instance group in RFC3339 text format.
    description String
    An optional description of this resource. Provide this property when you create the resource.
    fingerprint String
    The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
    kind String
    The resource type, which is always compute#instanceGroup for instance groups.
    name String
    The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
    namedPorts List<NamedPortResponse>
    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
    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.
    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).
    zone String
    The URL of the zone where the instance group is located (for zonal resources).
    creationTimestamp string
    The creation timestamp for this instance group in RFC3339 text format.
    description string
    An optional description of this resource. Provide this property when you create the resource.
    fingerprint string
    The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
    kind string
    The resource type, which is always compute#instanceGroup for instance groups.
    name string
    The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
    namedPorts NamedPortResponse[]
    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
    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.
    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).
    zone string
    The URL of the zone where the instance group is located (for zonal resources).
    creation_timestamp str
    The creation timestamp for this instance group in RFC3339 text format.
    description str
    An optional description of this resource. Provide this property when you create the resource.
    fingerprint str
    The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
    kind str
    The resource type, which is always compute#instanceGroup for instance groups.
    name str
    The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
    named_ports Sequence[NamedPortResponse]
    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 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.
    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).
    zone str
    The URL of the zone where the instance group is located (for zonal resources).
    creationTimestamp String
    The creation timestamp for this instance group in RFC3339 text format.
    description String
    An optional description of this resource. Provide this property when you create the resource.
    fingerprint String
    The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
    kind String
    The resource type, which is always compute#instanceGroup for instance groups.
    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.
    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.
    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).
    zone String
    The URL of the zone where the instance group is located (for zonal resources).

    Supporting Types

    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
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native