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

ibm.SatelliteClusterWorkerPoolZoneAttachment

Explore with Pulumi AI

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

    Provides a resource for satellite_cluster_worker_pool_zone_attachment. This allows satellite_cluster_worker_pool_zone_attachment to be created, updated and deleted.

    Example Usage

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

const satelliteClusterWorkerPoolZoneAttachment = new ibm.SatelliteClusterWorkerPoolZoneAttachment("satelliteClusterWorkerPoolZoneAttachment", {
    cluster: _var.cluster,
    workerPool: _var.worker_pool,
    zone: _var.zone_name,
});

    import pulumi
import pulumi_ibm as ibm

satellite_cluster_worker_pool_zone_attachment = ibm.SatelliteClusterWorkerPoolZoneAttachment("satelliteClusterWorkerPoolZoneAttachment",
    cluster=var["cluster"],
    worker_pool=var["worker_pool"],
    zone=var["zone_name"])

    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.NewSatelliteClusterWorkerPoolZoneAttachment(ctx, "satelliteClusterWorkerPoolZoneAttachment", &ibm.SatelliteClusterWorkerPoolZoneAttachmentArgs{
			Cluster:    pulumi.Any(_var.Cluster),
			WorkerPool: pulumi.Any(_var.Worker_pool),
			Zone:       pulumi.Any(_var.Zone_name),
		})
		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 satelliteClusterWorkerPoolZoneAttachment = new Ibm.SatelliteClusterWorkerPoolZoneAttachment("satelliteClusterWorkerPoolZoneAttachment", new()
    {
        Cluster = @var.Cluster,
        WorkerPool = @var.Worker_pool,
        Zone = @var.Zone_name,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SatelliteClusterWorkerPoolZoneAttachment;
import com.pulumi.ibm.SatelliteClusterWorkerPoolZoneAttachmentArgs;
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) {
        var satelliteClusterWorkerPoolZoneAttachment = new SatelliteClusterWorkerPoolZoneAttachment("satelliteClusterWorkerPoolZoneAttachment", SatelliteClusterWorkerPoolZoneAttachmentArgs.builder()
            .cluster(var_.cluster())
            .workerPool(var_.worker_pool())
            .zone(var_.zone_name())
            .build());

    }
}

    resources:
  satelliteClusterWorkerPoolZoneAttachment:
    type: ibm:SatelliteClusterWorkerPoolZoneAttachment
    properties:
      cluster: ${var.cluster}
      workerPool: ${var.worker_pool}
      zone: ${var.zone_name}

    Create SatelliteClusterWorkerPoolZoneAttachment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SatelliteClusterWorkerPoolZoneAttachment(name: string, args: SatelliteClusterWorkerPoolZoneAttachmentArgs, opts?: CustomResourceOptions);
    @overload
def SatelliteClusterWorkerPoolZoneAttachment(resource_name: str,
                                             args: SatelliteClusterWorkerPoolZoneAttachmentArgs,
                                             opts: Optional[ResourceOptions] = None)

@overload
def SatelliteClusterWorkerPoolZoneAttachment(resource_name: str,
                                             opts: Optional[ResourceOptions] = None,
                                             cluster: Optional[str] = None,
                                             worker_pool: Optional[str] = None,
                                             zone: Optional[str] = None,
                                             resource_group_id: Optional[str] = None,
                                             satellite_cluster_worker_pool_zone_attachment_id: Optional[str] = None)
    func NewSatelliteClusterWorkerPoolZoneAttachment(ctx *Context, name string, args SatelliteClusterWorkerPoolZoneAttachmentArgs, opts ...ResourceOption) (*SatelliteClusterWorkerPoolZoneAttachment, error)
    public SatelliteClusterWorkerPoolZoneAttachment(string name, SatelliteClusterWorkerPoolZoneAttachmentArgs args, CustomResourceOptions? opts = null)
    public SatelliteClusterWorkerPoolZoneAttachment(String name, SatelliteClusterWorkerPoolZoneAttachmentArgs args)
public SatelliteClusterWorkerPoolZoneAttachment(String name, SatelliteClusterWorkerPoolZoneAttachmentArgs args, CustomResourceOptions options)

    type: ibm:SatelliteClusterWorkerPoolZoneAttachment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SatelliteClusterWorkerPoolZoneAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SatelliteClusterWorkerPoolZoneAttachmentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SatelliteClusterWorkerPoolZoneAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SatelliteClusterWorkerPoolZoneAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SatelliteClusterWorkerPoolZoneAttachmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var satelliteClusterWorkerPoolZoneAttachmentResource = new Ibm.SatelliteClusterWorkerPoolZoneAttachment("satelliteClusterWorkerPoolZoneAttachmentResource", new()
{
    Cluster = "string",
    WorkerPool = "string",
    Zone = "string",
    ResourceGroupId = "string",
    SatelliteClusterWorkerPoolZoneAttachmentId = "string",
});

    example, err := ibm.NewSatelliteClusterWorkerPoolZoneAttachment(ctx, "satelliteClusterWorkerPoolZoneAttachmentResource", &ibm.SatelliteClusterWorkerPoolZoneAttachmentArgs{
	Cluster:         pulumi.String("string"),
	WorkerPool:      pulumi.String("string"),
	Zone:            pulumi.String("string"),
	ResourceGroupId: pulumi.String("string"),
	SatelliteClusterWorkerPoolZoneAttachmentId: pulumi.String("string"),
})

    var satelliteClusterWorkerPoolZoneAttachmentResource = new SatelliteClusterWorkerPoolZoneAttachment("satelliteClusterWorkerPoolZoneAttachmentResource", SatelliteClusterWorkerPoolZoneAttachmentArgs.builder()
    .cluster("string")
    .workerPool("string")
    .zone("string")
    .resourceGroupId("string")
    .satelliteClusterWorkerPoolZoneAttachmentId("string")
    .build());

    satellite_cluster_worker_pool_zone_attachment_resource = ibm.SatelliteClusterWorkerPoolZoneAttachment("satelliteClusterWorkerPoolZoneAttachmentResource",
    cluster="string",
    worker_pool="string",
    zone="string",
    resource_group_id="string",
    satellite_cluster_worker_pool_zone_attachment_id="string")

    const satelliteClusterWorkerPoolZoneAttachmentResource = new ibm.SatelliteClusterWorkerPoolZoneAttachment("satelliteClusterWorkerPoolZoneAttachmentResource", {
    cluster: "string",
    workerPool: "string",
    zone: "string",
    resourceGroupId: "string",
    satelliteClusterWorkerPoolZoneAttachmentId: "string",
});

    type: ibm:SatelliteClusterWorkerPoolZoneAttachment
properties:
    cluster: string
    resourceGroupId: string
    satelliteClusterWorkerPoolZoneAttachmentId: string
    workerPool: string
    zone: string

    SatelliteClusterWorkerPoolZoneAttachment Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SatelliteClusterWorkerPoolZoneAttachment resource accepts the following input properties:

    Cluster string
    The name of the cluster.
    WorkerPool string
    The name of the worker pool.
    Zone string
    (String) The name of the zone to attach.
    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.
    SatelliteClusterWorkerPoolZoneAttachmentId string
    (String) The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    Cluster string
    The name of the cluster.
    WorkerPool string
    The name of the worker pool.
    Zone string
    (String) The name of the zone to attach.
    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.
    SatelliteClusterWorkerPoolZoneAttachmentId string
    (String) The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    cluster String
    The name of the cluster.
    workerPool String
    The name of the worker pool.
    zone String
    (String) The name of the zone to attach.
    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.
    satelliteClusterWorkerPoolZoneAttachmentId String
    (String) The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    cluster string
    The name of the cluster.
    workerPool string
    The name of the worker pool.
    zone string
    (String) The name of the zone to attach.
    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.
    satelliteClusterWorkerPoolZoneAttachmentId string
    (String) The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    cluster str
    The name of the cluster.
    worker_pool str
    The name of the worker pool.
    zone str
    (String) The name of the zone to attach.
    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.
    satellite_cluster_worker_pool_zone_attachment_id str
    (String) The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    cluster String
    The name of the cluster.
    workerPool String
    The name of the worker pool.
    zone String
    (String) The name of the zone to attach.
    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.
    satelliteClusterWorkerPoolZoneAttachmentId String
    (String) The unique identifier of the satellite_cluster_worker_pool_zone_attachment.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SatelliteClusterWorkerPoolZoneAttachment resource produces the following output properties:

    AutobalanceEnabled bool
    (Optional, Boolean) Auto enabled status.
    Id string
    The provider-assigned unique ID for this managed resource.
    Messages List<string>
    (Optional, List) Messages.
    WorkerCount double
    (Optional, Integer) Number of workers in worker pool.
    AutobalanceEnabled bool
    (Optional, Boolean) Auto enabled status.
    Id string
    The provider-assigned unique ID for this managed resource.
    Messages []string
    (Optional, List) Messages.
    WorkerCount float64
    (Optional, Integer) Number of workers in worker pool.
    autobalanceEnabled Boolean
    (Optional, Boolean) Auto enabled status.
    id String
    The provider-assigned unique ID for this managed resource.
    messages List<String>
    (Optional, List) Messages.
    workerCount Double
    (Optional, Integer) Number of workers in worker pool.
    autobalanceEnabled boolean
    (Optional, Boolean) Auto enabled status.
    id string
    The provider-assigned unique ID for this managed resource.
    messages string[]
    (Optional, List) Messages.
    workerCount number
    (Optional, Integer) Number of workers in worker pool.
    autobalance_enabled bool
    (Optional, Boolean) Auto enabled status.
    id str
    The provider-assigned unique ID for this managed resource.
    messages Sequence[str]
    (Optional, List) Messages.
    worker_count float
    (Optional, Integer) Number of workers in worker pool.
    autobalanceEnabled Boolean
    (Optional, Boolean) Auto enabled status.
    id String
    The provider-assigned unique ID for this managed resource.
    messages List<String>
    (Optional, List) Messages.
    workerCount Number
    (Optional, Integer) Number of workers in worker pool.

    Look up Existing SatelliteClusterWorkerPoolZoneAttachment Resource

    Get an existing SatelliteClusterWorkerPoolZoneAttachment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SatelliteClusterWorkerPoolZoneAttachmentState, opts?: CustomResourceOptions): SatelliteClusterWorkerPoolZoneAttachment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        autobalance_enabled: Optional[bool] = None,
        cluster: Optional[str] = None,
        messages: Optional[Sequence[str]] = None,
        resource_group_id: Optional[str] = None,
        satellite_cluster_worker_pool_zone_attachment_id: Optional[str] = None,
        worker_count: Optional[float] = None,
        worker_pool: Optional[str] = None,
        zone: Optional[str] = None) -> SatelliteClusterWorkerPoolZoneAttachment
    func GetSatelliteClusterWorkerPoolZoneAttachment(ctx *Context, name string, id IDInput, state *SatelliteClusterWorkerPoolZoneAttachmentState, opts ...ResourceOption) (*SatelliteClusterWorkerPoolZoneAttachment, error)
    public static SatelliteClusterWorkerPoolZoneAttachment Get(string name, Input<string> id, SatelliteClusterWorkerPoolZoneAttachmentState? state, CustomResourceOptions? opts = null)
    public static SatelliteClusterWorkerPoolZoneAttachment get(String name, Output<String> id, SatelliteClusterWorkerPoolZoneAttachmentState state, CustomResourceOptions options)
    resources:  _:    type: ibm:SatelliteClusterWorkerPoolZoneAttachment    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutobalanceEnabled bool
    (Optional, Boolean) Auto enabled status.
    Cluster string
    The name of the cluster.
    Messages List<string>
    (Optional, List) Messages.
    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.
    SatelliteClusterWorkerPoolZoneAttachmentId string
    (String) The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    WorkerCount double
    (Optional, Integer) Number of workers in worker pool.
    WorkerPool string
    The name of the worker pool.
    Zone string
    (String) The name of the zone to attach.
    AutobalanceEnabled bool
    (Optional, Boolean) Auto enabled status.
    Cluster string
    The name of the cluster.
    Messages []string
    (Optional, List) Messages.
    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.
    SatelliteClusterWorkerPoolZoneAttachmentId string
    (String) The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    WorkerCount float64
    (Optional, Integer) Number of workers in worker pool.
    WorkerPool string
    The name of the worker pool.
    Zone string
    (String) The name of the zone to attach.
    autobalanceEnabled Boolean
    (Optional, Boolean) Auto enabled status.
    cluster String
    The name of the cluster.
    messages List<String>
    (Optional, List) Messages.
    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.
    satelliteClusterWorkerPoolZoneAttachmentId String
    (String) The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    workerCount Double
    (Optional, Integer) Number of workers in worker pool.
    workerPool String
    The name of the worker pool.
    zone String
    (String) The name of the zone to attach.
    autobalanceEnabled boolean
    (Optional, Boolean) Auto enabled status.
    cluster string
    The name of the cluster.
    messages string[]
    (Optional, List) Messages.
    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.
    satelliteClusterWorkerPoolZoneAttachmentId string
    (String) The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    workerCount number
    (Optional, Integer) Number of workers in worker pool.
    workerPool string
    The name of the worker pool.
    zone string
    (String) The name of the zone to attach.
    autobalance_enabled bool
    (Optional, Boolean) Auto enabled status.
    cluster str
    The name of the cluster.
    messages Sequence[str]
    (Optional, List) Messages.
    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.
    satellite_cluster_worker_pool_zone_attachment_id str
    (String) The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    worker_count float
    (Optional, Integer) Number of workers in worker pool.
    worker_pool str
    The name of the worker pool.
    zone str
    (String) The name of the zone to attach.
    autobalanceEnabled Boolean
    (Optional, Boolean) Auto enabled status.
    cluster String
    The name of the cluster.
    messages List<String>
    (Optional, List) Messages.
    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.
    satelliteClusterWorkerPoolZoneAttachmentId String
    (String) The unique identifier of the satellite_cluster_worker_pool_zone_attachment.
    workerCount Number
    (Optional, Integer) Number of workers in worker pool.
    workerPool String
    The name of the worker pool.
    zone String
    (String) The name of the zone to attach.

    Import

    You can import the ibm_satellite_cluster_worker_pool_zone_attachment resource can be imported by using the cluster and worker pool, zone name.

    /<worker_pool>/<zone_name>

    • cluster: A string. The cluster ID.

    • worker_pool: A string. The worker pool name.

    • zone_name: A string. The zone name.

    Syntax

    $ pulumi import ibm:index/satelliteClusterWorkerPoolZoneAttachment:SatelliteClusterWorkerPoolZoneAttachment satellite_cluster_worker_pool_zone_attachment <cluster>/<worker_pool>/<zone_name>

    To learn more about importing existing cloud resources, see Importing resources.

    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