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

ibm.getIsInstanceGroupMembership

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 instance group memership. For more information, about instance group membership, see bulk provisioning instances with instance groups.

    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

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

const example = ibm.getIsInstanceGroupMembership({
    instanceGroup: ibm_is_instance_group.example.id,
    name: "example-ig-membership",
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_instance_group_membership(instance_group=ibm_is_instance_group["example"]["id"],
    name="example-ig-membership")

    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.LookupIsInstanceGroupMembership(ctx, &ibm.LookupIsInstanceGroupMembershipArgs{
			InstanceGroup: ibm_is_instance_group.Example.Id,
			Name:          "example-ig-membership",
		}, 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.GetIsInstanceGroupMembership.Invoke(new()
    {
        InstanceGroup = ibm_is_instance_group.Example.Id,
        Name = "example-ig-membership",
    });

});

    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.GetIsInstanceGroupMembershipArgs;
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.getIsInstanceGroupMembership(GetIsInstanceGroupMembershipArgs.builder()
            .instanceGroup(ibm_is_instance_group.example().id())
            .name("example-ig-membership")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ibm:getIsInstanceGroupMembership
      arguments:
        instanceGroup: ${ibm_is_instance_group.example.id}
        name: example-ig-membership

    Using getIsInstanceGroupMembership

    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 getIsInstanceGroupMembership(args: GetIsInstanceGroupMembershipArgs, opts?: InvokeOptions): Promise<GetIsInstanceGroupMembershipResult>
function getIsInstanceGroupMembershipOutput(args: GetIsInstanceGroupMembershipOutputArgs, opts?: InvokeOptions): Output<GetIsInstanceGroupMembershipResult>
    def get_is_instance_group_membership(id: Optional[str] = None,
                                     instance_group: Optional[str] = None,
                                     name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetIsInstanceGroupMembershipResult
def get_is_instance_group_membership_output(id: Optional[pulumi.Input[str]] = None,
                                     instance_group: Optional[pulumi.Input[str]] = None,
                                     name: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetIsInstanceGroupMembershipResult]
    func LookupIsInstanceGroupMembership(ctx *Context, args *LookupIsInstanceGroupMembershipArgs, opts ...InvokeOption) (*LookupIsInstanceGroupMembershipResult, error)
func LookupIsInstanceGroupMembershipOutput(ctx *Context, args *LookupIsInstanceGroupMembershipOutputArgs, opts ...InvokeOption) LookupIsInstanceGroupMembershipResultOutput

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

    public static class GetIsInstanceGroupMembership 
{
    public static Task<GetIsInstanceGroupMembershipResult> InvokeAsync(GetIsInstanceGroupMembershipArgs args, InvokeOptions? opts = null)
    public static Output<GetIsInstanceGroupMembershipResult> Invoke(GetIsInstanceGroupMembershipInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIsInstanceGroupMembershipResult> getIsInstanceGroupMembership(GetIsInstanceGroupMembershipArgs args, InvokeOptions options)
public static Output<GetIsInstanceGroupMembershipResult> getIsInstanceGroupMembership(GetIsInstanceGroupMembershipArgs args, InvokeOptions options)

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

    The following arguments are supported:

    InstanceGroup string
    The instance group identifier.
    Name string
    The name of the instance group membership.
    Id string
    (String) The ID is the combination of instance group ID and instance group membership ID.
    InstanceGroup string
    The instance group identifier.
    Name string
    The name of the instance group membership.
    Id string
    (String) The ID is the combination of instance group ID and instance group membership ID.
    instanceGroup String
    The instance group identifier.
    name String
    The name of the instance group membership.
    id String
    (String) The ID is the combination of instance group ID and instance group membership ID.
    instanceGroup string
    The instance group identifier.
    name string
    The name of the instance group membership.
    id string
    (String) The ID is the combination of instance group ID and instance group membership ID.
    instance_group str
    The instance group identifier.
    name str
    The name of the instance group membership.
    id str
    (String) The ID is the combination of instance group ID and instance group membership ID.
    instanceGroup String
    The instance group identifier.
    name String
    The name of the instance group membership.
    id String
    (String) The ID is the combination of instance group ID and instance group membership ID.

    getIsInstanceGroupMembership Result

    The following output properties are available:

    DeleteInstanceOnMembershipDelete bool
    (Bool) If set to true, when deleting the membership the instance will also be deleted.
    Id string
    (String) The ID is the combination of instance group ID and instance group membership ID.
    InstanceGroup string
    InstanceGroupMembership string
    (String) The unique identifier for this instance group membership.
    InstanceTemplates List<GetIsInstanceGroupMembershipInstanceTemplate>
    (String) The unique identifier for this instance template.
    Instances List<GetIsInstanceGroupMembershipInstance>
    (List) Nested instance blocks have the following structure:
    LoadBalancerPoolMember string
    (String) The unique identifier for this load balancer pool member.
    Name string
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.
    Status string
    (String) The status of the instance group membership
    DeleteInstanceOnMembershipDelete bool
    (Bool) If set to true, when deleting the membership the instance will also be deleted.
    Id string
    (String) The ID is the combination of instance group ID and instance group membership ID.
    InstanceGroup string
    InstanceGroupMembership string
    (String) The unique identifier for this instance group membership.
    InstanceTemplates []GetIsInstanceGroupMembershipInstanceTemplate
    (String) The unique identifier for this instance template.
    Instances []GetIsInstanceGroupMembershipInstance
    (List) Nested instance blocks have the following structure:
    LoadBalancerPoolMember string
    (String) The unique identifier for this load balancer pool member.
    Name string
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.
    Status string
    (String) The status of the instance group membership
    deleteInstanceOnMembershipDelete Boolean
    (Bool) If set to true, when deleting the membership the instance will also be deleted.
    id String
    (String) The ID is the combination of instance group ID and instance group membership ID.
    instanceGroup String
    instanceGroupMembership String
    (String) The unique identifier for this instance group membership.
    instanceTemplates List<GetIsInstanceGroupMembershipInstanceTemplate>
    (String) The unique identifier for this instance template.
    instances List<GetIsInstanceGroupMembershipInstance>
    (List) Nested instance blocks have the following structure:
    loadBalancerPoolMember String
    (String) The unique identifier for this load balancer pool member.
    name String
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.
    status String
    (String) The status of the instance group membership
    deleteInstanceOnMembershipDelete boolean
    (Bool) If set to true, when deleting the membership the instance will also be deleted.
    id string
    (String) The ID is the combination of instance group ID and instance group membership ID.
    instanceGroup string
    instanceGroupMembership string
    (String) The unique identifier for this instance group membership.
    instanceTemplates GetIsInstanceGroupMembershipInstanceTemplate[]
    (String) The unique identifier for this instance template.
    instances GetIsInstanceGroupMembershipInstance[]
    (List) Nested instance blocks have the following structure:
    loadBalancerPoolMember string
    (String) The unique identifier for this load balancer pool member.
    name string
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.
    status string
    (String) The status of the instance group membership
    delete_instance_on_membership_delete bool
    (Bool) If set to true, when deleting the membership the instance will also be deleted.
    id str
    (String) The ID is the combination of instance group ID and instance group membership ID.
    instance_group str
    instance_group_membership str
    (String) The unique identifier for this instance group membership.
    instance_templates Sequence[GetIsInstanceGroupMembershipInstanceTemplate]
    (String) The unique identifier for this instance template.
    instances Sequence[GetIsInstanceGroupMembershipInstance]
    (List) Nested instance blocks have the following structure:
    load_balancer_pool_member str
    (String) The unique identifier for this load balancer pool member.
    name str
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.
    status str
    (String) The status of the instance group membership
    deleteInstanceOnMembershipDelete Boolean
    (Bool) If set to true, when deleting the membership the instance will also be deleted.
    id String
    (String) The ID is the combination of instance group ID and instance group membership ID.
    instanceGroup String
    instanceGroupMembership String
    (String) The unique identifier for this instance group membership.
    instanceTemplates List<Property Map>
    (String) The unique identifier for this instance template.
    instances List<Property Map>
    (List) Nested instance blocks have the following structure:
    loadBalancerPoolMember String
    (String) The unique identifier for this load balancer pool member.
    name String
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.
    status String
    (String) The status of the instance group membership

    Supporting Types

    GetIsInstanceGroupMembershipInstance

    Crn string
    (String) The CRN for this instance template.
    Name string
    The name of the instance group membership.
    VirtualServerInstance string
    (String) The unique identifier for this virtual server instance.
    Crn string
    (String) The CRN for this instance template.
    Name string
    The name of the instance group membership.
    VirtualServerInstance string
    (String) The unique identifier for this virtual server instance.
    crn String
    (String) The CRN for this instance template.
    name String
    The name of the instance group membership.
    virtualServerInstance String
    (String) The unique identifier for this virtual server instance.
    crn string
    (String) The CRN for this instance template.
    name string
    The name of the instance group membership.
    virtualServerInstance string
    (String) The unique identifier for this virtual server instance.
    crn str
    (String) The CRN for this instance template.
    name str
    The name of the instance group membership.
    virtual_server_instance str
    (String) The unique identifier for this virtual server instance.
    crn String
    (String) The CRN for this instance template.
    name String
    The name of the instance group membership.
    virtualServerInstance String
    (String) The unique identifier for this virtual server instance.

    GetIsInstanceGroupMembershipInstanceTemplate

    Crn string
    (String) The CRN for this instance template.
    InstanceTemplate string
    (String) The unique identifier for this instance template.
    Name string
    The name of the instance group membership.
    Crn string
    (String) The CRN for this instance template.
    InstanceTemplate string
    (String) The unique identifier for this instance template.
    Name string
    The name of the instance group membership.
    crn String
    (String) The CRN for this instance template.
    instanceTemplate String
    (String) The unique identifier for this instance template.
    name String
    The name of the instance group membership.
    crn string
    (String) The CRN for this instance template.
    instanceTemplate string
    (String) The unique identifier for this instance template.
    name string
    The name of the instance group membership.
    crn str
    (String) The CRN for this instance template.
    instance_template str
    (String) The unique identifier for this instance template.
    name str
    The name of the instance group membership.
    crn String
    (String) The CRN for this instance template.
    instanceTemplate String
    (String) The unique identifier for this instance template.
    name String
    The name of the instance group membership.

    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