1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsInstanceGroupManagerAction
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getIsInstanceGroupManagerAction

Explore with Pulumi AI

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

    Retrive information about an instance group manager. For more information, about VPC instance group manager action, see scheduled 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

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const example = ibm.getIsInstanceGroupManagerAction({
        instanceGroup: ibm_is_instance_group.example.id,
        instanceGroupManager: ibm_is_instance_group_manager.example.manager_id,
        name: "example-instance-group-manager-action",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    example = ibm.get_is_instance_group_manager_action(instance_group=ibm_is_instance_group["example"]["id"],
        instance_group_manager=ibm_is_instance_group_manager["example"]["manager_id"],
        name="example-instance-group-manager-action")
    
    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.LookupIsInstanceGroupManagerAction(ctx, &ibm.LookupIsInstanceGroupManagerActionArgs{
    			InstanceGroup:        ibm_is_instance_group.Example.Id,
    			InstanceGroupManager: ibm_is_instance_group_manager.Example.Manager_id,
    			Name:                 "example-instance-group-manager-action",
    		}, 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.GetIsInstanceGroupManagerAction.Invoke(new()
        {
            InstanceGroup = ibm_is_instance_group.Example.Id,
            InstanceGroupManager = ibm_is_instance_group_manager.Example.Manager_id,
            Name = "example-instance-group-manager-action",
        });
    
    });
    
    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.GetIsInstanceGroupManagerActionArgs;
    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.getIsInstanceGroupManagerAction(GetIsInstanceGroupManagerActionArgs.builder()
                .instanceGroup(ibm_is_instance_group.example().id())
                .instanceGroupManager(ibm_is_instance_group_manager.example().manager_id())
                .name("example-instance-group-manager-action")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ibm:getIsInstanceGroupManagerAction
          arguments:
            instanceGroup: ${ibm_is_instance_group.example.id}
            instanceGroupManager: ${ibm_is_instance_group_manager.example.manager_id}
            name: example-instance-group-manager-action
    

    Using getIsInstanceGroupManagerAction

    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 getIsInstanceGroupManagerAction(args: GetIsInstanceGroupManagerActionArgs, opts?: InvokeOptions): Promise<GetIsInstanceGroupManagerActionResult>
    function getIsInstanceGroupManagerActionOutput(args: GetIsInstanceGroupManagerActionOutputArgs, opts?: InvokeOptions): Output<GetIsInstanceGroupManagerActionResult>
    def get_is_instance_group_manager_action(id: Optional[str] = None,
                                             instance_group: Optional[str] = None,
                                             instance_group_manager: Optional[str] = None,
                                             name: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetIsInstanceGroupManagerActionResult
    def get_is_instance_group_manager_action_output(id: Optional[pulumi.Input[str]] = None,
                                             instance_group: Optional[pulumi.Input[str]] = None,
                                             instance_group_manager: Optional[pulumi.Input[str]] = None,
                                             name: Optional[pulumi.Input[str]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[GetIsInstanceGroupManagerActionResult]
    func LookupIsInstanceGroupManagerAction(ctx *Context, args *LookupIsInstanceGroupManagerActionArgs, opts ...InvokeOption) (*LookupIsInstanceGroupManagerActionResult, error)
    func LookupIsInstanceGroupManagerActionOutput(ctx *Context, args *LookupIsInstanceGroupManagerActionOutputArgs, opts ...InvokeOption) LookupIsInstanceGroupManagerActionResultOutput

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

    public static class GetIsInstanceGroupManagerAction 
    {
        public static Task<GetIsInstanceGroupManagerActionResult> InvokeAsync(GetIsInstanceGroupManagerActionArgs args, InvokeOptions? opts = null)
        public static Output<GetIsInstanceGroupManagerActionResult> Invoke(GetIsInstanceGroupManagerActionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIsInstanceGroupManagerActionResult> getIsInstanceGroupManagerAction(GetIsInstanceGroupManagerActionArgs args, InvokeOptions options)
    public static Output<GetIsInstanceGroupManagerActionResult> getIsInstanceGroupManagerAction(GetIsInstanceGroupManagerActionArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getIsInstanceGroupManagerAction:getIsInstanceGroupManagerAction
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceGroup string
    The instance group identifier.
    InstanceGroupManager string
    The instance group manager identifier of type scheduled.
    Name string
    The instance group manager action name.
    Id string
    (String) The ID is the combination of instance group ID, instance group manager ID and instance group manager action ID.
    InstanceGroup string
    The instance group identifier.
    InstanceGroupManager string
    The instance group manager identifier of type scheduled.
    Name string
    The instance group manager action name.
    Id string
    (String) The ID is the combination of instance group ID, instance group manager ID and instance group manager action ID.
    instanceGroup String
    The instance group identifier.
    instanceGroupManager String
    The instance group manager identifier of type scheduled.
    name String
    The instance group manager action name.
    id String
    (String) The ID is the combination of instance group ID, instance group manager ID and instance group manager action ID.
    instanceGroup string
    The instance group identifier.
    instanceGroupManager string
    The instance group manager identifier of type scheduled.
    name string
    The instance group manager action name.
    id string
    (String) The ID is the combination of instance group ID, instance group manager ID and instance group manager action ID.
    instance_group str
    The instance group identifier.
    instance_group_manager str
    The instance group manager identifier of type scheduled.
    name str
    The instance group manager action name.
    id str
    (String) The ID is the combination of instance group ID, instance group manager ID and instance group manager action ID.
    instanceGroup String
    The instance group identifier.
    instanceGroupManager String
    The instance group manager identifier of type scheduled.
    name String
    The instance group manager action name.
    id String
    (String) The ID is the combination of instance group ID, instance group manager ID and instance group manager action ID.

    getIsInstanceGroupManagerAction Result

    The following output properties are available:

    ActionId string
    (String) The unique identifier of the ibm_is_instance_group_manager_action.
    ActionType string
    (String) The type of action for the instance group.
    AutoDelete bool
    (String) If set to true, this scheduled action will be automatically deleted after it has finished and the auto_delete_timeout time has passed.
    AutoDeleteTimeout double
    (String) Amount of time in hours that are required to pass before the scheduled action will be automatically deleted once it has finished. If this value is 0, the action will be deleted on completion.
    CreatedAt string
    (Timestamp) The date and time that the instance group manager action was created.
    CronSpec string
    (String) The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 minimum period.
    Id string
    (String) The ID is the combination of instance group ID, instance group manager ID and instance group manager action ID.
    InstanceGroup string
    InstanceGroupManager string
    LastAppliedAt string
    (Timestamp) The date and time the scheduled action was last applied. If empty the action has never been applied.
    MaxMembershipCount double
    (Integer) The maximum number of members the instance group should have at the scheduled time.
    MembershipCount double
    (Integer) The number of members the instance group should have at the scheduled time.
    MinMembershipCount double
    (Integer) The minimum number of members the instance group should have at the scheduled time. Default value is set to 1.
    Name string
    (String) The user-defined name for this instance group manager action. Names must be unique within the instance group manager.
    NextRunAt string
    (Timestamp) The date and time the scheduled action will next run. If empty the system is currently calculating the next run time.
    ResourceType string
    (String) The resource type.
    RunAt string
    Status string
    (String) The status of the instance group action.
    TargetManager string
    (String) The unique identifier for this instance group manager of type autoscale.
    TargetManagerName string
    (String) Name of instance group manager of type autoscale.
    UpdatedAt string
    (String) The date and time that the instance group manager action was modified.
    ActionId string
    (String) The unique identifier of the ibm_is_instance_group_manager_action.
    ActionType string
    (String) The type of action for the instance group.
    AutoDelete bool
    (String) If set to true, this scheduled action will be automatically deleted after it has finished and the auto_delete_timeout time has passed.
    AutoDeleteTimeout float64
    (String) Amount of time in hours that are required to pass before the scheduled action will be automatically deleted once it has finished. If this value is 0, the action will be deleted on completion.
    CreatedAt string
    (Timestamp) The date and time that the instance group manager action was created.
    CronSpec string
    (String) The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 minimum period.
    Id string
    (String) The ID is the combination of instance group ID, instance group manager ID and instance group manager action ID.
    InstanceGroup string
    InstanceGroupManager string
    LastAppliedAt string
    (Timestamp) The date and time the scheduled action was last applied. If empty the action has never been applied.
    MaxMembershipCount float64
    (Integer) The maximum number of members the instance group should have at the scheduled time.
    MembershipCount float64
    (Integer) The number of members the instance group should have at the scheduled time.
    MinMembershipCount float64
    (Integer) The minimum number of members the instance group should have at the scheduled time. Default value is set to 1.
    Name string
    (String) The user-defined name for this instance group manager action. Names must be unique within the instance group manager.
    NextRunAt string
    (Timestamp) The date and time the scheduled action will next run. If empty the system is currently calculating the next run time.
    ResourceType string
    (String) The resource type.
    RunAt string
    Status string
    (String) The status of the instance group action.
    TargetManager string
    (String) The unique identifier for this instance group manager of type autoscale.
    TargetManagerName string
    (String) Name of instance group manager of type autoscale.
    UpdatedAt string
    (String) The date and time that the instance group manager action was modified.
    actionId String
    (String) The unique identifier of the ibm_is_instance_group_manager_action.
    actionType String
    (String) The type of action for the instance group.
    autoDelete Boolean
    (String) If set to true, this scheduled action will be automatically deleted after it has finished and the auto_delete_timeout time has passed.
    autoDeleteTimeout Double
    (String) Amount of time in hours that are required to pass before the scheduled action will be automatically deleted once it has finished. If this value is 0, the action will be deleted on completion.
    createdAt String
    (Timestamp) The date and time that the instance group manager action was created.
    cronSpec String
    (String) The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 minimum period.
    id String
    (String) The ID is the combination of instance group ID, instance group manager ID and instance group manager action ID.
    instanceGroup String
    instanceGroupManager String
    lastAppliedAt String
    (Timestamp) The date and time the scheduled action was last applied. If empty the action has never been applied.
    maxMembershipCount Double
    (Integer) The maximum number of members the instance group should have at the scheduled time.
    membershipCount Double
    (Integer) The number of members the instance group should have at the scheduled time.
    minMembershipCount Double
    (Integer) The minimum number of members the instance group should have at the scheduled time. Default value is set to 1.
    name String
    (String) The user-defined name for this instance group manager action. Names must be unique within the instance group manager.
    nextRunAt String
    (Timestamp) The date and time the scheduled action will next run. If empty the system is currently calculating the next run time.
    resourceType String
    (String) The resource type.
    runAt String
    status String
    (String) The status of the instance group action.
    targetManager String
    (String) The unique identifier for this instance group manager of type autoscale.
    targetManagerName String
    (String) Name of instance group manager of type autoscale.
    updatedAt String
    (String) The date and time that the instance group manager action was modified.
    actionId string
    (String) The unique identifier of the ibm_is_instance_group_manager_action.
    actionType string
    (String) The type of action for the instance group.
    autoDelete boolean
    (String) If set to true, this scheduled action will be automatically deleted after it has finished and the auto_delete_timeout time has passed.
    autoDeleteTimeout number
    (String) Amount of time in hours that are required to pass before the scheduled action will be automatically deleted once it has finished. If this value is 0, the action will be deleted on completion.
    createdAt string
    (Timestamp) The date and time that the instance group manager action was created.
    cronSpec string
    (String) The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 minimum period.
    id string
    (String) The ID is the combination of instance group ID, instance group manager ID and instance group manager action ID.
    instanceGroup string
    instanceGroupManager string
    lastAppliedAt string
    (Timestamp) The date and time the scheduled action was last applied. If empty the action has never been applied.
    maxMembershipCount number
    (Integer) The maximum number of members the instance group should have at the scheduled time.
    membershipCount number
    (Integer) The number of members the instance group should have at the scheduled time.
    minMembershipCount number
    (Integer) The minimum number of members the instance group should have at the scheduled time. Default value is set to 1.
    name string
    (String) The user-defined name for this instance group manager action. Names must be unique within the instance group manager.
    nextRunAt string
    (Timestamp) The date and time the scheduled action will next run. If empty the system is currently calculating the next run time.
    resourceType string
    (String) The resource type.
    runAt string
    status string
    (String) The status of the instance group action.
    targetManager string
    (String) The unique identifier for this instance group manager of type autoscale.
    targetManagerName string
    (String) Name of instance group manager of type autoscale.
    updatedAt string
    (String) The date and time that the instance group manager action was modified.
    action_id str
    (String) The unique identifier of the ibm_is_instance_group_manager_action.
    action_type str
    (String) The type of action for the instance group.
    auto_delete bool
    (String) If set to true, this scheduled action will be automatically deleted after it has finished and the auto_delete_timeout time has passed.
    auto_delete_timeout float
    (String) Amount of time in hours that are required to pass before the scheduled action will be automatically deleted once it has finished. If this value is 0, the action will be deleted on completion.
    created_at str
    (Timestamp) The date and time that the instance group manager action was created.
    cron_spec str
    (String) The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 minimum period.
    id str
    (String) The ID is the combination of instance group ID, instance group manager ID and instance group manager action ID.
    instance_group str
    instance_group_manager str
    last_applied_at str
    (Timestamp) The date and time the scheduled action was last applied. If empty the action has never been applied.
    max_membership_count float
    (Integer) The maximum number of members the instance group should have at the scheduled time.
    membership_count float
    (Integer) The number of members the instance group should have at the scheduled time.
    min_membership_count float
    (Integer) The minimum number of members the instance group should have at the scheduled time. Default value is set to 1.
    name str
    (String) The user-defined name for this instance group manager action. Names must be unique within the instance group manager.
    next_run_at str
    (Timestamp) The date and time the scheduled action will next run. If empty the system is currently calculating the next run time.
    resource_type str
    (String) The resource type.
    run_at str
    status str
    (String) The status of the instance group action.
    target_manager str
    (String) The unique identifier for this instance group manager of type autoscale.
    target_manager_name str
    (String) Name of instance group manager of type autoscale.
    updated_at str
    (String) The date and time that the instance group manager action was modified.
    actionId String
    (String) The unique identifier of the ibm_is_instance_group_manager_action.
    actionType String
    (String) The type of action for the instance group.
    autoDelete Boolean
    (String) If set to true, this scheduled action will be automatically deleted after it has finished and the auto_delete_timeout time has passed.
    autoDeleteTimeout Number
    (String) Amount of time in hours that are required to pass before the scheduled action will be automatically deleted once it has finished. If this value is 0, the action will be deleted on completion.
    createdAt String
    (Timestamp) The date and time that the instance group manager action was created.
    cronSpec String
    (String) The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 minimum period.
    id String
    (String) The ID is the combination of instance group ID, instance group manager ID and instance group manager action ID.
    instanceGroup String
    instanceGroupManager String
    lastAppliedAt String
    (Timestamp) The date and time the scheduled action was last applied. If empty the action has never been applied.
    maxMembershipCount Number
    (Integer) The maximum number of members the instance group should have at the scheduled time.
    membershipCount Number
    (Integer) The number of members the instance group should have at the scheduled time.
    minMembershipCount Number
    (Integer) The minimum number of members the instance group should have at the scheduled time. Default value is set to 1.
    name String
    (String) The user-defined name for this instance group manager action. Names must be unique within the instance group manager.
    nextRunAt String
    (Timestamp) The date and time the scheduled action will next run. If empty the system is currently calculating the next run time.
    resourceType String
    (String) The resource type.
    runAt String
    status String
    (String) The status of the instance group action.
    targetManager String
    (String) The unique identifier for this instance group manager of type autoscale.
    targetManagerName String
    (String) Name of instance group manager of type autoscale.
    updatedAt String
    (String) The date and time that the instance group manager action was modified.

    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