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

ibm.getSatelliteClusterWorkerPoolZoneAttachment

Explore with Pulumi AI

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

    Import the details of an existing satellite cluster worker pool zone attached as a read-only data source. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const readWorkerPoolZoneAttachment = ibm.getSatelliteClusterWorkerPoolZoneAttachment({
        cluster: "satellite-cluster",
        workerPool: "default",
        zone: "zone-4",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    read_worker_pool_zone_attachment = ibm.get_satellite_cluster_worker_pool_zone_attachment(cluster="satellite-cluster",
        worker_pool="default",
        zone="zone-4")
    
    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.LookupSatelliteClusterWorkerPoolZoneAttachment(ctx, &ibm.LookupSatelliteClusterWorkerPoolZoneAttachmentArgs{
    			Cluster:    "satellite-cluster",
    			WorkerPool: "default",
    			Zone:       "zone-4",
    		}, 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 readWorkerPoolZoneAttachment = Ibm.GetSatelliteClusterWorkerPoolZoneAttachment.Invoke(new()
        {
            Cluster = "satellite-cluster",
            WorkerPool = "default",
            Zone = "zone-4",
        });
    
    });
    
    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.GetSatelliteClusterWorkerPoolZoneAttachmentArgs;
    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 readWorkerPoolZoneAttachment = IbmFunctions.getSatelliteClusterWorkerPoolZoneAttachment(GetSatelliteClusterWorkerPoolZoneAttachmentArgs.builder()
                .cluster("satellite-cluster")
                .workerPool("default")
                .zone("zone-4")
                .build());
    
        }
    }
    
    variables:
      readWorkerPoolZoneAttachment:
        fn::invoke:
          function: ibm:getSatelliteClusterWorkerPoolZoneAttachment
          arguments:
            cluster: satellite-cluster
            workerPool: default
            zone: zone-4
    

    Using getSatelliteClusterWorkerPoolZoneAttachment

    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 getSatelliteClusterWorkerPoolZoneAttachment(args: GetSatelliteClusterWorkerPoolZoneAttachmentArgs, opts?: InvokeOptions): Promise<GetSatelliteClusterWorkerPoolZoneAttachmentResult>
    function getSatelliteClusterWorkerPoolZoneAttachmentOutput(args: GetSatelliteClusterWorkerPoolZoneAttachmentOutputArgs, opts?: InvokeOptions): Output<GetSatelliteClusterWorkerPoolZoneAttachmentResult>
    def get_satellite_cluster_worker_pool_zone_attachment(cluster: Optional[str] = None,
                                                          id: Optional[str] = None,
                                                          resource_group_id: Optional[str] = None,
                                                          worker_pool: Optional[str] = None,
                                                          zone: Optional[str] = None,
                                                          opts: Optional[InvokeOptions] = None) -> GetSatelliteClusterWorkerPoolZoneAttachmentResult
    def get_satellite_cluster_worker_pool_zone_attachment_output(cluster: Optional[pulumi.Input[str]] = None,
                                                          id: Optional[pulumi.Input[str]] = None,
                                                          resource_group_id: Optional[pulumi.Input[str]] = None,
                                                          worker_pool: Optional[pulumi.Input[str]] = None,
                                                          zone: Optional[pulumi.Input[str]] = None,
                                                          opts: Optional[InvokeOptions] = None) -> Output[GetSatelliteClusterWorkerPoolZoneAttachmentResult]
    func LookupSatelliteClusterWorkerPoolZoneAttachment(ctx *Context, args *LookupSatelliteClusterWorkerPoolZoneAttachmentArgs, opts ...InvokeOption) (*LookupSatelliteClusterWorkerPoolZoneAttachmentResult, error)
    func LookupSatelliteClusterWorkerPoolZoneAttachmentOutput(ctx *Context, args *LookupSatelliteClusterWorkerPoolZoneAttachmentOutputArgs, opts ...InvokeOption) LookupSatelliteClusterWorkerPoolZoneAttachmentResultOutput

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

    public static class GetSatelliteClusterWorkerPoolZoneAttachment 
    {
        public static Task<GetSatelliteClusterWorkerPoolZoneAttachmentResult> InvokeAsync(GetSatelliteClusterWorkerPoolZoneAttachmentArgs args, InvokeOptions? opts = null)
        public static Output<GetSatelliteClusterWorkerPoolZoneAttachmentResult> Invoke(GetSatelliteClusterWorkerPoolZoneAttachmentInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSatelliteClusterWorkerPoolZoneAttachmentResult> getSatelliteClusterWorkerPoolZoneAttachment(GetSatelliteClusterWorkerPoolZoneAttachmentArgs args, InvokeOptions options)
    public static Output<GetSatelliteClusterWorkerPoolZoneAttachmentResult> getSatelliteClusterWorkerPoolZoneAttachment(GetSatelliteClusterWorkerPoolZoneAttachmentArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getSatelliteClusterWorkerPoolZoneAttachment:getSatelliteClusterWorkerPoolZoneAttachment
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Cluster string
    The name or id of the cluster.
    WorkerPool string
    The name of the worker pool.
    Zone string
    The name of the zone to attach.
    Id string
    The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    ResourceGroupId string
    The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the GET /v2/satellite/getController API method.
    Cluster string
    The name or id of the cluster.
    WorkerPool string
    The name of the worker pool.
    Zone string
    The name of the zone to attach.
    Id string
    The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    ResourceGroupId string
    The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the GET /v2/satellite/getController API method.
    cluster String
    The name or id of the cluster.
    workerPool String
    The name of the worker pool.
    zone String
    The name of the zone to attach.
    id String
    The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    resourceGroupId String
    The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the GET /v2/satellite/getController API method.
    cluster string
    The name or id of the cluster.
    workerPool string
    The name of the worker pool.
    zone string
    The name of the zone to attach.
    id string
    The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    resourceGroupId string
    The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the GET /v2/satellite/getController API method.
    cluster str
    The name or id of the cluster.
    worker_pool str
    The name of the worker pool.
    zone str
    The name of the zone to attach.
    id str
    The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    resource_group_id str
    The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the GET /v2/satellite/getController API method.
    cluster String
    The name or id of the cluster.
    workerPool String
    The name of the worker pool.
    zone String
    The name of the zone to attach.
    id String
    The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    resourceGroupId String
    The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the GET /v2/satellite/getController API method.

    getSatelliteClusterWorkerPoolZoneAttachment Result

    The following output properties are available:

    AutobalanceEnabled bool
    Auto enabled status.
    Cluster string
    Id string
    The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    Messages List<string>
    Messages.
    WorkerCount double
    Number of workers in worker pool.
    WorkerPool string
    Zone string
    ResourceGroupId string
    AutobalanceEnabled bool
    Auto enabled status.
    Cluster string
    Id string
    The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    Messages []string
    Messages.
    WorkerCount float64
    Number of workers in worker pool.
    WorkerPool string
    Zone string
    ResourceGroupId string
    autobalanceEnabled Boolean
    Auto enabled status.
    cluster String
    id String
    The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    messages List<String>
    Messages.
    workerCount Double
    Number of workers in worker pool.
    workerPool String
    zone String
    resourceGroupId String
    autobalanceEnabled boolean
    Auto enabled status.
    cluster string
    id string
    The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    messages string[]
    Messages.
    workerCount number
    Number of workers in worker pool.
    workerPool string
    zone string
    resourceGroupId string
    autobalance_enabled bool
    Auto enabled status.
    cluster str
    id str
    The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    messages Sequence[str]
    Messages.
    worker_count float
    Number of workers in worker pool.
    worker_pool str
    zone str
    resource_group_id str
    autobalanceEnabled Boolean
    Auto enabled status.
    cluster String
    id String
    The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    messages List<String>
    Messages.
    workerCount Number
    Number of workers in worker pool.
    workerPool String
    zone String
    resourceGroupId String

    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