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

ibm.getIsInstanceGroupMemberships

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 all the instance group membership information of an instance group. For more information, about instance group membership, see required permissions.

    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.getIsInstanceGroupMemberships({
    instanceGroup: ibm_is_instance_group.example.id,
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_instance_group_memberships(instance_group=ibm_is_instance_group["example"]["id"])

    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.GetIsInstanceGroupMemberships(ctx, &ibm.GetIsInstanceGroupMembershipsArgs{
			InstanceGroup: ibm_is_instance_group.Example.Id,
		}, 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.GetIsInstanceGroupMemberships.Invoke(new()
    {
        InstanceGroup = ibm_is_instance_group.Example.Id,
    });

});

    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.GetIsInstanceGroupMembershipsArgs;
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.getIsInstanceGroupMemberships(GetIsInstanceGroupMembershipsArgs.builder()
            .instanceGroup(ibm_is_instance_group.example().id())
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ibm:getIsInstanceGroupMemberships
      arguments:
        instanceGroup: ${ibm_is_instance_group.example.id}

    Using getIsInstanceGroupMemberships

    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 getIsInstanceGroupMemberships(args: GetIsInstanceGroupMembershipsArgs, opts?: InvokeOptions): Promise<GetIsInstanceGroupMembershipsResult>
function getIsInstanceGroupMembershipsOutput(args: GetIsInstanceGroupMembershipsOutputArgs, opts?: InvokeOptions): Output<GetIsInstanceGroupMembershipsResult>
    def get_is_instance_group_memberships(id: Optional[str] = None,
                                      instance_group: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetIsInstanceGroupMembershipsResult
def get_is_instance_group_memberships_output(id: Optional[pulumi.Input[str]] = None,
                                      instance_group: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetIsInstanceGroupMembershipsResult]
    func GetIsInstanceGroupMemberships(ctx *Context, args *GetIsInstanceGroupMembershipsArgs, opts ...InvokeOption) (*GetIsInstanceGroupMembershipsResult, error)
func GetIsInstanceGroupMembershipsOutput(ctx *Context, args *GetIsInstanceGroupMembershipsOutputArgs, opts ...InvokeOption) GetIsInstanceGroupMembershipsResultOutput

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

    public static class GetIsInstanceGroupMemberships 
{
    public static Task<GetIsInstanceGroupMembershipsResult> InvokeAsync(GetIsInstanceGroupMembershipsArgs args, InvokeOptions? opts = null)
    public static Output<GetIsInstanceGroupMembershipsResult> Invoke(GetIsInstanceGroupMembershipsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIsInstanceGroupMembershipsResult> getIsInstanceGroupMemberships(GetIsInstanceGroupMembershipsArgs args, InvokeOptions options)
public static Output<GetIsInstanceGroupMembershipsResult> getIsInstanceGroupMemberships(GetIsInstanceGroupMembershipsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    InstanceGroup string
    The instance group identifier.
    Id string
    (String) The unique identifier of the instance group membership collection.
    InstanceGroup string
    The instance group identifier.
    Id string
    (String) The unique identifier of the instance group membership collection.
    instanceGroup String
    The instance group identifier.
    id String
    (String) The unique identifier of the instance group membership collection.
    instanceGroup string
    The instance group identifier.
    id string
    (String) The unique identifier of the instance group membership collection.
    instance_group str
    The instance group identifier.
    id str
    (String) The unique identifier of the instance group membership collection.
    instanceGroup String
    The instance group identifier.
    id String
    (String) The unique identifier of the instance group membership collection.

    getIsInstanceGroupMemberships Result

    The following output properties are available:

    Id string
    (String) The unique identifier of the instance group membership collection.
    InstanceGroup string
    Memberships List<GetIsInstanceGroupMembershipsMembership>
    (List) Collection of instance group memberships. Nested memberships blocks have the following structure:
    Id string
    (String) The unique identifier of the instance group membership collection.
    InstanceGroup string
    Memberships []GetIsInstanceGroupMembershipsMembership
    (List) Collection of instance group memberships. Nested memberships blocks have the following structure:
    id String
    (String) The unique identifier of the instance group membership collection.
    instanceGroup String
    memberships List<GetIsInstanceGroupMembershipsMembership>
    (List) Collection of instance group memberships. Nested memberships blocks have the following structure:
    id string
    (String) The unique identifier of the instance group membership collection.
    instanceGroup string
    memberships GetIsInstanceGroupMembershipsMembership[]
    (List) Collection of instance group memberships. Nested memberships blocks have the following structure:
    id str
    (String) The unique identifier of the instance group membership collection.
    instance_group str
    memberships Sequence[GetIsInstanceGroupMembershipsMembership]
    (List) Collection of instance group memberships. Nested memberships blocks have the following structure:
    id String
    (String) The unique identifier of the instance group membership collection.
    instanceGroup String
    memberships List<Property Map>
    (List) Collection of instance group memberships. Nested memberships blocks have the following structure:

    Supporting Types

    GetIsInstanceGroupMembershipsMembership

    DeleteInstanceOnMembershipDelete bool
    (String) If set to true, when deleting the membership the instance gets deleted.
    InstanceGroupMembership string
    The unique identifier for this instance group membership.
    InstanceTemplates List<GetIsInstanceGroupMembershipsMembershipInstanceTemplate>
    (String) The unique identifier for this instance template.
    Instances List<GetIsInstanceGroupMembershipsMembershipInstance>
    (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
    (String) If set to true, when deleting the membership the instance gets deleted.
    InstanceGroupMembership string
    The unique identifier for this instance group membership.
    InstanceTemplates []GetIsInstanceGroupMembershipsMembershipInstanceTemplate
    (String) The unique identifier for this instance template.
    Instances []GetIsInstanceGroupMembershipsMembershipInstance
    (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
    (String) If set to true, when deleting the membership the instance gets deleted.
    instanceGroupMembership String
    The unique identifier for this instance group membership.
    instanceTemplates List<GetIsInstanceGroupMembershipsMembershipInstanceTemplate>
    (String) The unique identifier for this instance template.
    instances List<GetIsInstanceGroupMembershipsMembershipInstance>
    (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
    (String) If set to true, when deleting the membership the instance gets deleted.
    instanceGroupMembership string
    The unique identifier for this instance group membership.
    instanceTemplates GetIsInstanceGroupMembershipsMembershipInstanceTemplate[]
    (String) The unique identifier for this instance template.
    instances GetIsInstanceGroupMembershipsMembershipInstance[]
    (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
    (String) If set to true, when deleting the membership the instance gets deleted.
    instance_group_membership str
    The unique identifier for this instance group membership.
    instance_templates Sequence[GetIsInstanceGroupMembershipsMembershipInstanceTemplate]
    (String) The unique identifier for this instance template.
    instances Sequence[GetIsInstanceGroupMembershipsMembershipInstance]
    (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
    (String) If set to true, when deleting the membership the instance gets deleted.
    instanceGroupMembership 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.

    GetIsInstanceGroupMembershipsMembershipInstance

    Crn string
    (String) The CRN for this instance template.
    Name string
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.
    VirtualServerInstance string
    (String) The unique identifier for this virtual server instance.
    Crn string
    (String) The CRN for this instance template.
    Name string
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.
    VirtualServerInstance string
    (String) The unique identifier for this virtual server instance.
    crn String
    (String) The CRN for this instance template.
    name String
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.
    virtualServerInstance String
    (String) The unique identifier for this virtual server instance.
    crn string
    (String) The CRN for this instance template.
    name string
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.
    virtualServerInstance string
    (String) The unique identifier for this virtual server instance.
    crn str
    (String) The CRN for this instance template.
    name str
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.
    virtual_server_instance str
    (String) The unique identifier for this virtual server instance.
    crn String
    (String) The CRN for this instance template.
    name String
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.
    virtualServerInstance String
    (String) The unique identifier for this virtual server instance.

    GetIsInstanceGroupMembershipsMembershipInstanceTemplate

    Crn string
    (String) The CRN for this instance template.
    InstanceTemplate string
    (String) The unique identifier for this instance template.
    Name string
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.
    Crn string
    (String) The CRN for this instance template.
    InstanceTemplate string
    (String) The unique identifier for this instance template.
    Name string
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.
    crn String
    (String) The CRN for this instance template.
    instanceTemplate String
    (String) The unique identifier for this instance template.
    name String
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.
    crn string
    (String) The CRN for this instance template.
    instanceTemplate string
    (String) The unique identifier for this instance template.
    name string
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.
    crn str
    (String) The CRN for this instance template.
    instance_template str
    (String) The unique identifier for this instance template.
    name str
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.
    crn String
    (String) The CRN for this instance template.
    instanceTemplate String
    (String) The unique identifier for this instance template.
    name String
    (String) The user-defined name for this instance group membership. Names must be unique within the instance group.

    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