1. Packages
  2. Scaleway
  3. API Docs
  4. autoscaling
  5. getInstanceGroup
Viewing docs for Scaleway v1.44.1
published on Monday, Mar 9, 2026 by pulumiverse
scaleway logo
Viewing docs for Scaleway v1.44.1
published on Monday, Mar 9, 2026 by pulumiverse

    Gets information about an Autoscaling Instance group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    // Get info by name
    const byName = scaleway.autoscaling.getInstanceGroup({
        name: "my-instance-group",
    });
    // Get info by ID
    const byId = scaleway.autoscaling.getInstanceGroup({
        instanceGroupId: "11111111-1111-1111-1111-111111111111",
    });
    
    import pulumi
    import pulumi_scaleway as scaleway
    
    # Get info by name
    by_name = scaleway.autoscaling.get_instance_group(name="my-instance-group")
    # Get info by ID
    by_id = scaleway.autoscaling.get_instance_group(instance_group_id="11111111-1111-1111-1111-111111111111")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/autoscaling"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Get info by name
    		_, err := autoscaling.LookupInstanceGroup(ctx, &autoscaling.LookupInstanceGroupArgs{
    			Name: pulumi.StringRef("my-instance-group"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		// Get info by ID
    		_, err = autoscaling.LookupInstanceGroup(ctx, &autoscaling.LookupInstanceGroupArgs{
    			InstanceGroupId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scaleway = Pulumi.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        // Get info by name
        var byName = Scaleway.Autoscaling.GetInstanceGroup.Invoke(new()
        {
            Name = "my-instance-group",
        });
    
        // Get info by ID
        var byId = Scaleway.Autoscaling.GetInstanceGroup.Invoke(new()
        {
            InstanceGroupId = "11111111-1111-1111-1111-111111111111",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.autoscaling.AutoscalingFunctions;
    import com.pulumi.scaleway.autoscaling.inputs.GetInstanceGroupArgs;
    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) {
            // Get info by name
            final var byName = AutoscalingFunctions.getInstanceGroup(GetInstanceGroupArgs.builder()
                .name("my-instance-group")
                .build());
    
            // Get info by ID
            final var byId = AutoscalingFunctions.getInstanceGroup(GetInstanceGroupArgs.builder()
                .instanceGroupId("11111111-1111-1111-1111-111111111111")
                .build());
    
        }
    }
    
    variables:
      # Get info by name
      byName:
        fn::invoke:
          function: scaleway:autoscaling:getInstanceGroup
          arguments:
            name: my-instance-group
      # Get info by ID
      byId:
        fn::invoke:
          function: scaleway:autoscaling:getInstanceGroup
          arguments:
            instanceGroupId: 11111111-1111-1111-1111-111111111111
    

    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_id: Optional[str] = None,
                           name: Optional[str] = None,
                           zone: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetInstanceGroupResult
    def get_instance_group_output(instance_group_id: Optional[pulumi.Input[str]] = None,
                           name: 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)
    public static Output<GetInstanceGroupResult> getInstanceGroup(GetInstanceGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: scaleway:autoscaling/getInstanceGroup:getInstanceGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceGroupId string
    The ID of the Instance group. Only one of name and instance_group_id should be specified.
    Name string
    The name of the Instance group. Only one of name and instance_group_id should be specified.
    Zone string
    zone) The zone in which the Instance group exists.
    InstanceGroupId string
    The ID of the Instance group. Only one of name and instance_group_id should be specified.
    Name string
    The name of the Instance group. Only one of name and instance_group_id should be specified.
    Zone string
    zone) The zone in which the Instance group exists.
    instanceGroupId String
    The ID of the Instance group. Only one of name and instance_group_id should be specified.
    name String
    The name of the Instance group. Only one of name and instance_group_id should be specified.
    zone String
    zone) The zone in which the Instance group exists.
    instanceGroupId string
    The ID of the Instance group. Only one of name and instance_group_id should be specified.
    name string
    The name of the Instance group. Only one of name and instance_group_id should be specified.
    zone string
    zone) The zone in which the Instance group exists.
    instance_group_id str
    The ID of the Instance group. Only one of name and instance_group_id should be specified.
    name str
    The name of the Instance group. Only one of name and instance_group_id should be specified.
    zone str
    zone) The zone in which the Instance group exists.
    instanceGroupId String
    The ID of the Instance group. Only one of name and instance_group_id should be specified.
    name String
    The name of the Instance group. Only one of name and instance_group_id should be specified.
    zone String
    zone) The zone in which the Instance group exists.

    getInstanceGroup Result

    The following output properties are available:

    Capacities []GetInstanceGroupCapacity
    CreatedAt string
    DeleteServersOnDestroy bool
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancers []GetInstanceGroupLoadBalancer
    ProjectId string
    Tags []string
    TemplateId string
    UpdatedAt string
    InstanceGroupId string
    Name string
    Zone string
    capacities List<GetInstanceGroupCapacity>
    createdAt String
    deleteServersOnDestroy Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancers List<GetInstanceGroupLoadBalancer>
    projectId String
    tags List<String>
    templateId String
    updatedAt String
    instanceGroupId String
    name String
    zone String
    capacities GetInstanceGroupCapacity[]
    createdAt string
    deleteServersOnDestroy boolean
    id string
    The provider-assigned unique ID for this managed resource.
    loadBalancers GetInstanceGroupLoadBalancer[]
    projectId string
    tags string[]
    templateId string
    updatedAt string
    instanceGroupId string
    name string
    zone string
    capacities List<Property Map>
    createdAt String
    deleteServersOnDestroy Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancers List<Property Map>
    projectId String
    tags List<String>
    templateId String
    updatedAt String
    instanceGroupId String
    name String
    zone String

    Supporting Types

    GetInstanceGroupCapacity

    CooldownDelay int
    Time (in seconds) after a scaling action during which requests to carry out a new scaling action will be denied
    MaxReplicas int
    The maximum count of Instances for the Instance group
    MinReplicas int
    The minimum count of Instances for the Instance group
    CooldownDelay int
    Time (in seconds) after a scaling action during which requests to carry out a new scaling action will be denied
    MaxReplicas int
    The maximum count of Instances for the Instance group
    MinReplicas int
    The minimum count of Instances for the Instance group
    cooldownDelay Integer
    Time (in seconds) after a scaling action during which requests to carry out a new scaling action will be denied
    maxReplicas Integer
    The maximum count of Instances for the Instance group
    minReplicas Integer
    The minimum count of Instances for the Instance group
    cooldownDelay number
    Time (in seconds) after a scaling action during which requests to carry out a new scaling action will be denied
    maxReplicas number
    The maximum count of Instances for the Instance group
    minReplicas number
    The minimum count of Instances for the Instance group
    cooldown_delay int
    Time (in seconds) after a scaling action during which requests to carry out a new scaling action will be denied
    max_replicas int
    The maximum count of Instances for the Instance group
    min_replicas int
    The minimum count of Instances for the Instance group
    cooldownDelay Number
    Time (in seconds) after a scaling action during which requests to carry out a new scaling action will be denied
    maxReplicas Number
    The maximum count of Instances for the Instance group
    minReplicas Number
    The minimum count of Instances for the Instance group

    GetInstanceGroupLoadBalancer

    BackendIds List<string>
    The Load Balancer backend IDs
    Id string
    The ID of the load balancer
    PrivateNetworkId string
    The ID of the Private Network attached to the Load Balancer
    BackendIds []string
    The Load Balancer backend IDs
    Id string
    The ID of the load balancer
    PrivateNetworkId string
    The ID of the Private Network attached to the Load Balancer
    backendIds List<String>
    The Load Balancer backend IDs
    id String
    The ID of the load balancer
    privateNetworkId String
    The ID of the Private Network attached to the Load Balancer
    backendIds string[]
    The Load Balancer backend IDs
    id string
    The ID of the load balancer
    privateNetworkId string
    The ID of the Private Network attached to the Load Balancer
    backend_ids Sequence[str]
    The Load Balancer backend IDs
    id str
    The ID of the load balancer
    private_network_id str
    The ID of the Private Network attached to the Load Balancer
    backendIds List<String>
    The Load Balancer backend IDs
    id String
    The ID of the load balancer
    privateNetworkId String
    The ID of the Private Network attached to the Load Balancer

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Viewing docs for Scaleway v1.44.1
    published on Monday, Mar 9, 2026 by pulumiverse
      Try Pulumi Cloud free. Your team will thank you.