Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsInstanceGroup
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getIsInstanceGroup

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Retrieve information of an exisitng VPC instance group. For more information, about VPC instance group information, see creating an instance group for auto scaling.

    Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

    provider.tf

    import * as pulumi from "@pulumi/pulumi";

    import pulumi

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

    {}

    Example Usage

    The following example gets an instance group information.

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const example = ibm.getIsInstanceGroup({
    name: ibm_is_instance_group.example.name,
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_instance_group(name=ibm_is_instance_group["example"]["name"])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.LookupIsInstanceGroup(ctx, &ibm.LookupIsInstanceGroupArgs{
			Name: ibm_is_instance_group.Example.Name,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = Ibm.GetIsInstanceGroup.Invoke(new()
    {
        Name = ibm_is_instance_group.Example.Name,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetIsInstanceGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = IbmFunctions.getIsInstanceGroup(GetIsInstanceGroupArgs.builder()
            .name(ibm_is_instance_group.example().name())
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ibm:getIsInstanceGroup
      arguments:
        name: ${ibm_is_instance_group.example.name}

    Using getIsInstanceGroup

    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 getIsInstanceGroup(args: GetIsInstanceGroupArgs, opts?: InvokeOptions): Promise<GetIsInstanceGroupResult>
function getIsInstanceGroupOutput(args: GetIsInstanceGroupOutputArgs, opts?: InvokeOptions): Output<GetIsInstanceGroupResult>
    def get_is_instance_group(id: Optional[str] = None,
                          name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetIsInstanceGroupResult
def get_is_instance_group_output(id: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetIsInstanceGroupResult]
    func LookupIsInstanceGroup(ctx *Context, args *LookupIsInstanceGroupArgs, opts ...InvokeOption) (*LookupIsInstanceGroupResult, error)
func LookupIsInstanceGroupOutput(ctx *Context, args *LookupIsInstanceGroupOutputArgs, opts ...InvokeOption) LookupIsInstanceGroupResultOutput

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

    public static class GetIsInstanceGroup 
{
    public static Task<GetIsInstanceGroupResult> InvokeAsync(GetIsInstanceGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetIsInstanceGroupResult> Invoke(GetIsInstanceGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIsInstanceGroupResult> getIsInstanceGroup(GetIsInstanceGroupArgs args, InvokeOptions options)
public static Output<GetIsInstanceGroupResult> getIsInstanceGroup(GetIsInstanceGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getIsInstanceGroup:getIsInstanceGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of an instance group.
    Id string
    (String) The ID of an instance group.
    Name string
    The name of an instance group.
    Id string
    (String) The ID of an instance group.
    name String
    The name of an instance group.
    id String
    (String) The ID of an instance group.
    name string
    The name of an instance group.
    id string
    (String) The ID of an instance group.
    name str
    The name of an instance group.
    id str
    (String) The ID of an instance group.
    name String
    The name of an instance group.
    id String
    (String) The ID of an instance group.

    getIsInstanceGroup Result

    The following output properties are available:

    AccessTags List<string>
    (List) Access management tags associated for the instance group.
    ApplicationPort double
    (String) Scales an instances to supply the port for the Load Balancer pool member.
    Crn string
    (String) The CRN for this instance group.
    Id string
    (String) The ID of an instance group.
    InstanceTemplate string
    (String) The ID of an instance template to create an instance group.
    LoadBalancerPool string
    (String) The Load Balancer pool ID.
    Managers List<string>
    (String) List of managers associated with the instance group.
    MembershipCount double
    Name string
    ResourceGroup string
    (String) The resource group ID.
    Status string
    (String) The status of an instance group.
    Subnets List<string>
    (String) The list of subnet IDs used by an instances.
    Vpc string
    (String) The VPC ID.
    AccessTags []string
    (List) Access management tags associated for the instance group.
    ApplicationPort float64
    (String) Scales an instances to supply the port for the Load Balancer pool member.
    Crn string
    (String) The CRN for this instance group.
    Id string
    (String) The ID of an instance group.
    InstanceTemplate string
    (String) The ID of an instance template to create an instance group.
    LoadBalancerPool string
    (String) The Load Balancer pool ID.
    Managers []string
    (String) List of managers associated with the instance group.
    MembershipCount float64
    Name string
    ResourceGroup string
    (String) The resource group ID.
    Status string
    (String) The status of an instance group.
    Subnets []string
    (String) The list of subnet IDs used by an instances.
    Vpc string
    (String) The VPC ID.
    accessTags List<String>
    (List) Access management tags associated for the instance group.
    applicationPort Double
    (String) Scales an instances to supply the port for the Load Balancer pool member.
    crn String
    (String) The CRN for this instance group.
    id String
    (String) The ID of an instance group.
    instanceTemplate String
    (String) The ID of an instance template to create an instance group.
    loadBalancerPool String
    (String) The Load Balancer pool ID.
    managers List<String>
    (String) List of managers associated with the instance group.
    membershipCount Double
    name String
    resourceGroup String
    (String) The resource group ID.
    status String
    (String) The status of an instance group.
    subnets List<String>
    (String) The list of subnet IDs used by an instances.
    vpc String
    (String) The VPC ID.
    accessTags string[]
    (List) Access management tags associated for the instance group.
    applicationPort number
    (String) Scales an instances to supply the port for the Load Balancer pool member.
    crn string
    (String) The CRN for this instance group.
    id string
    (String) The ID of an instance group.
    instanceTemplate string
    (String) The ID of an instance template to create an instance group.
    loadBalancerPool string
    (String) The Load Balancer pool ID.
    managers string[]
    (String) List of managers associated with the instance group.
    membershipCount number
    name string
    resourceGroup string
    (String) The resource group ID.
    status string
    (String) The status of an instance group.
    subnets string[]
    (String) The list of subnet IDs used by an instances.
    vpc string
    (String) The VPC ID.
    access_tags Sequence[str]
    (List) Access management tags associated for the instance group.
    application_port float
    (String) Scales an instances to supply the port for the Load Balancer pool member.
    crn str
    (String) The CRN for this instance group.
    id str
    (String) The ID of an instance group.
    instance_template str
    (String) The ID of an instance template to create an instance group.
    load_balancer_pool str
    (String) The Load Balancer pool ID.
    managers Sequence[str]
    (String) List of managers associated with the instance group.
    membership_count float
    name str
    resource_group str
    (String) The resource group ID.
    status str
    (String) The status of an instance group.
    subnets Sequence[str]
    (String) The list of subnet IDs used by an instances.
    vpc str
    (String) The VPC ID.
    accessTags List<String>
    (List) Access management tags associated for the instance group.
    applicationPort Number
    (String) Scales an instances to supply the port for the Load Balancer pool member.
    crn String
    (String) The CRN for this instance group.
    id String
    (String) The ID of an instance group.
    instanceTemplate String
    (String) The ID of an instance template to create an instance group.
    loadBalancerPool String
    (String) The Load Balancer pool ID.
    managers List<String>
    (String) List of managers associated with the instance group.
    membershipCount Number
    name String
    resourceGroup String
    (String) The resource group ID.
    status String
    (String) The status of an instance group.
    subnets List<String>
    (String) The list of subnet IDs used by an instances.
    vpc String
    (String) The VPC ID.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm