1. Packages
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. id
  6. WorkloadPool
Viewing docs for bytepluscc v0.0.42
published on Monday, Jul 20, 2026 by Byteplus
bytepluscc logo
Viewing docs for bytepluscc v0.0.42
published on Monday, Jul 20, 2026 by Byteplus

    Workload pool

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as bytepluscc from "@byteplus/pulumi-bytepluscc";
    
    const example = new bytepluscc.id.WorkloadPool("Example", {
        description: "用于测试的工作负载池",
        projectName: "default",
        workloadPoolName: "demo-workload-pool-full",
        tags: [{
            key: "env",
            value: "test",
        }],
    });
    
    import pulumi
    import pulumi_bytepluscc as bytepluscc
    
    example = bytepluscc.id.WorkloadPool("Example",
        description="用于测试的工作负载池",
        project_name="default",
        workload_pool_name="demo-workload-pool-full",
        tags=[{
            "key": "env",
            "value": "test",
        }])
    
    package main
    
    import (
    	"github.com/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/id"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := id.NewWorkloadPool(ctx, "Example", &id.WorkloadPoolArgs{
    			Description:      pulumi.String("用于测试的工作负载池"),
    			ProjectName:      pulumi.String("default"),
    			WorkloadPoolName: pulumi.String("demo-workload-pool-full"),
    			Tags: id.WorkloadPoolTagArray{
    				&id.WorkloadPoolTagArgs{
    					Key:   pulumi.String("env"),
    					Value: pulumi.String("test"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Bytepluscc = Byteplus.Pulumi.Bytepluscc;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Bytepluscc.Id.WorkloadPool("Example", new()
        {
            Description = "用于测试的工作负载池",
            ProjectName = "default",
            WorkloadPoolName = "demo-workload-pool-full",
            Tags = new[]
            {
                new Bytepluscc.Id.Inputs.WorkloadPoolTagArgs
                {
                    Key = "env",
                    Value = "test",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.byteplus.bytepluscc.id.WorkloadPool;
    import com.byteplus.bytepluscc.id.WorkloadPoolArgs;
    import com.pulumi.bytepluscc.id.inputs.WorkloadPoolTagArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 example = new WorkloadPool("example", WorkloadPoolArgs.builder()
                .description("用于测试的工作负载池")
                .projectName("default")
                .workloadPoolName("demo-workload-pool-full")
                .tags(WorkloadPoolTagArgs.builder()
                    .key("env")
                    .value("test")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: bytepluscc:id:WorkloadPool
        name: Example
        properties:
          description: 用于测试的工作负载池
          projectName: default
          workloadPoolName: demo-workload-pool-full
          tags:
            - key: env
              value: test
    
    pulumi {
      required_providers {
        bytepluscc = {
          source = "pulumi/bytepluscc"
        }
      }
    }
    
    resource "bytepluscc_id_workloadpool" "Example" {
      description        = "用于测试的工作负载池"
      project_name       = "default"
      workload_pool_name = "demo-workload-pool-full"
      tags {
        key   = "env"
        value = "test"
      }
    }
    

    Create WorkloadPool Resource

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

    Constructor syntax

    new WorkloadPool(name: string, args: WorkloadPoolArgs, opts?: CustomResourceOptions);
    @overload
    def WorkloadPool(resource_name: str,
                     args: WorkloadPoolArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkloadPool(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     workload_pool_name: Optional[str] = None,
                     description: Optional[str] = None,
                     project_name: Optional[str] = None,
                     tags: Optional[Sequence[WorkloadPoolTagArgs]] = None)
    func NewWorkloadPool(ctx *Context, name string, args WorkloadPoolArgs, opts ...ResourceOption) (*WorkloadPool, error)
    public WorkloadPool(string name, WorkloadPoolArgs args, CustomResourceOptions? opts = null)
    public WorkloadPool(String name, WorkloadPoolArgs args)
    public WorkloadPool(String name, WorkloadPoolArgs args, CustomResourceOptions options)
    
    type: bytepluscc:id:WorkloadPool
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "bytepluscc_id_workload_pool" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args WorkloadPoolArgs
    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 WorkloadPoolArgs
    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 WorkloadPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkloadPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkloadPoolArgs
    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 workloadPoolResource = new Bytepluscc.Id.WorkloadPool("workloadPoolResource", new()
    {
        WorkloadPoolName = "string",
        Description = "string",
        ProjectName = "string",
        Tags = new[]
        {
            new Bytepluscc.Id.Inputs.WorkloadPoolTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
    });
    
    example, err := id.NewWorkloadPool(ctx, "workloadPoolResource", &id.WorkloadPoolArgs{
    	WorkloadPoolName: pulumi.String("string"),
    	Description:      pulumi.String("string"),
    	ProjectName:      pulumi.String("string"),
    	Tags: id.WorkloadPoolTagArray{
    		&id.WorkloadPoolTagArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    })
    
    resource "bytepluscc_id_workload_pool" "workloadPoolResource" {
      lifecycle {
        create_before_destroy = true
      }
      workload_pool_name = "string"
      description        = "string"
      project_name       = "string"
      tags {
        key   = "string"
        value = "string"
      }
    }
    
    var workloadPoolResource = new WorkloadPool("workloadPoolResource", WorkloadPoolArgs.builder()
        .workloadPoolName("string")
        .description("string")
        .projectName("string")
        .tags(WorkloadPoolTagArgs.builder()
            .key("string")
            .value("string")
            .build())
        .build());
    
    workload_pool_resource = bytepluscc.id.WorkloadPool("workloadPoolResource",
        workload_pool_name="string",
        description="string",
        project_name="string",
        tags=[{
            "key": "string",
            "value": "string",
        }])
    
    const workloadPoolResource = new bytepluscc.id.WorkloadPool("workloadPoolResource", {
        workloadPoolName: "string",
        description: "string",
        projectName: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    type: bytepluscc:id:WorkloadPool
    properties:
        description: string
        projectName: string
        tags:
            - key: string
              value: string
        workloadPoolName: string
    

    WorkloadPool 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 WorkloadPool resource accepts the following input properties:

    WorkloadPoolName string
    Workload pool name
    Description string
    Workload pool description
    ProjectName string
    Project name
    Tags List<Byteplus.WorkloadPoolTag>
    Resource tags. You can categorize instances by tags to facilitate instance search and resource aggregation. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    WorkloadPoolName string
    Workload pool name
    Description string
    Workload pool description
    ProjectName string
    Project name
    Tags []WorkloadPoolTagArgs
    Resource tags. You can categorize instances by tags to facilitate instance search and resource aggregation. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    workload_pool_name string
    Workload pool name
    description string
    Workload pool description
    project_name string
    Project name
    tags list(object)
    Resource tags. You can categorize instances by tags to facilitate instance search and resource aggregation. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    workloadPoolName String
    Workload pool name
    description String
    Workload pool description
    projectName String
    Project name
    tags List<WorkloadPoolTag>
    Resource tags. You can categorize instances by tags to facilitate instance search and resource aggregation. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    workloadPoolName string
    Workload pool name
    description string
    Workload pool description
    projectName string
    Project name
    tags WorkloadPoolTag[]
    Resource tags. You can categorize instances by tags to facilitate instance search and resource aggregation. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    workload_pool_name str
    Workload pool name
    description str
    Workload pool description
    project_name str
    Project name
    tags Sequence[WorkloadPoolTagArgs]
    Resource tags. You can categorize instances by tags to facilitate instance search and resource aggregation. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    workloadPoolName String
    Workload pool name
    description String
    Workload pool description
    projectName String
    Project name
    tags List<Property Map>
    Resource tags. You can categorize instances by tags to facilitate instance search and resource aggregation. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.

    Outputs

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

    CreatedAt string
    Workload pool creation time
    DiscoveryUrl string
    OIDC discovery endpoint
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCredentials int
    Number of associated credentials
    TotalWorkloads int
    Number of workloads
    Trn string
    Workload pool Trn
    UpdatedAt string
    Workload pool update time
    WorkloadPoolId string
    Workload pool ID
    CreatedAt string
    Workload pool creation time
    DiscoveryUrl string
    OIDC discovery endpoint
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCredentials int
    Number of associated credentials
    TotalWorkloads int
    Number of workloads
    Trn string
    Workload pool Trn
    UpdatedAt string
    Workload pool update time
    WorkloadPoolId string
    Workload pool ID
    created_at string
    Workload pool creation time
    discovery_url string
    OIDC discovery endpoint
    id string
    The provider-assigned unique ID for this managed resource.
    total_credentials number
    Number of associated credentials
    total_workloads number
    Number of workloads
    trn string
    Workload pool Trn
    updated_at string
    Workload pool update time
    workload_pool_id string
    Workload pool ID
    createdAt String
    Workload pool creation time
    discoveryUrl String
    OIDC discovery endpoint
    id String
    The provider-assigned unique ID for this managed resource.
    totalCredentials Integer
    Number of associated credentials
    totalWorkloads Integer
    Number of workloads
    trn String
    Workload pool Trn
    updatedAt String
    Workload pool update time
    workloadPoolId String
    Workload pool ID
    createdAt string
    Workload pool creation time
    discoveryUrl string
    OIDC discovery endpoint
    id string
    The provider-assigned unique ID for this managed resource.
    totalCredentials number
    Number of associated credentials
    totalWorkloads number
    Number of workloads
    trn string
    Workload pool Trn
    updatedAt string
    Workload pool update time
    workloadPoolId string
    Workload pool ID
    created_at str
    Workload pool creation time
    discovery_url str
    OIDC discovery endpoint
    id str
    The provider-assigned unique ID for this managed resource.
    total_credentials int
    Number of associated credentials
    total_workloads int
    Number of workloads
    trn str
    Workload pool Trn
    updated_at str
    Workload pool update time
    workload_pool_id str
    Workload pool ID
    createdAt String
    Workload pool creation time
    discoveryUrl String
    OIDC discovery endpoint
    id String
    The provider-assigned unique ID for this managed resource.
    totalCredentials Number
    Number of associated credentials
    totalWorkloads Number
    Number of workloads
    trn String
    Workload pool Trn
    updatedAt String
    Workload pool update time
    workloadPoolId String
    Workload pool ID

    Look up Existing WorkloadPool Resource

    Get an existing WorkloadPool 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?: WorkloadPoolState, opts?: CustomResourceOptions): WorkloadPool
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_at: Optional[str] = None,
            description: Optional[str] = None,
            discovery_url: Optional[str] = None,
            project_name: Optional[str] = None,
            tags: Optional[Sequence[WorkloadPoolTagArgs]] = None,
            total_credentials: Optional[int] = None,
            total_workloads: Optional[int] = None,
            trn: Optional[str] = None,
            updated_at: Optional[str] = None,
            workload_pool_id: Optional[str] = None,
            workload_pool_name: Optional[str] = None) -> WorkloadPool
    func GetWorkloadPool(ctx *Context, name string, id IDInput, state *WorkloadPoolState, opts ...ResourceOption) (*WorkloadPool, error)
    public static WorkloadPool Get(string name, Input<string> id, WorkloadPoolState? state, CustomResourceOptions? opts = null)
    public static WorkloadPool get(String name, Output<String> id, WorkloadPoolState state, CustomResourceOptions options)
    resources:  _:    type: bytepluscc:id:WorkloadPool    get:      id: ${id}
    import {
      to = bytepluscc_id_workload_pool.example
      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:
    CreatedAt string
    Workload pool creation time
    Description string
    Workload pool description
    DiscoveryUrl string
    OIDC discovery endpoint
    ProjectName string
    Project name
    Tags List<Byteplus.WorkloadPoolTag>
    Resource tags. You can categorize instances by tags to facilitate instance search and resource aggregation. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    TotalCredentials int
    Number of associated credentials
    TotalWorkloads int
    Number of workloads
    Trn string
    Workload pool Trn
    UpdatedAt string
    Workload pool update time
    WorkloadPoolId string
    Workload pool ID
    WorkloadPoolName string
    Workload pool name
    CreatedAt string
    Workload pool creation time
    Description string
    Workload pool description
    DiscoveryUrl string
    OIDC discovery endpoint
    ProjectName string
    Project name
    Tags []WorkloadPoolTagArgs
    Resource tags. You can categorize instances by tags to facilitate instance search and resource aggregation. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    TotalCredentials int
    Number of associated credentials
    TotalWorkloads int
    Number of workloads
    Trn string
    Workload pool Trn
    UpdatedAt string
    Workload pool update time
    WorkloadPoolId string
    Workload pool ID
    WorkloadPoolName string
    Workload pool name
    created_at string
    Workload pool creation time
    description string
    Workload pool description
    discovery_url string
    OIDC discovery endpoint
    project_name string
    Project name
    tags list(object)
    Resource tags. You can categorize instances by tags to facilitate instance search and resource aggregation. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    total_credentials number
    Number of associated credentials
    total_workloads number
    Number of workloads
    trn string
    Workload pool Trn
    updated_at string
    Workload pool update time
    workload_pool_id string
    Workload pool ID
    workload_pool_name string
    Workload pool name
    createdAt String
    Workload pool creation time
    description String
    Workload pool description
    discoveryUrl String
    OIDC discovery endpoint
    projectName String
    Project name
    tags List<WorkloadPoolTag>
    Resource tags. You can categorize instances by tags to facilitate instance search and resource aggregation. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    totalCredentials Integer
    Number of associated credentials
    totalWorkloads Integer
    Number of workloads
    trn String
    Workload pool Trn
    updatedAt String
    Workload pool update time
    workloadPoolId String
    Workload pool ID
    workloadPoolName String
    Workload pool name
    createdAt string
    Workload pool creation time
    description string
    Workload pool description
    discoveryUrl string
    OIDC discovery endpoint
    projectName string
    Project name
    tags WorkloadPoolTag[]
    Resource tags. You can categorize instances by tags to facilitate instance search and resource aggregation. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    totalCredentials number
    Number of associated credentials
    totalWorkloads number
    Number of workloads
    trn string
    Workload pool Trn
    updatedAt string
    Workload pool update time
    workloadPoolId string
    Workload pool ID
    workloadPoolName string
    Workload pool name
    created_at str
    Workload pool creation time
    description str
    Workload pool description
    discovery_url str
    OIDC discovery endpoint
    project_name str
    Project name
    tags Sequence[WorkloadPoolTagArgs]
    Resource tags. You can categorize instances by tags to facilitate instance search and resource aggregation. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    total_credentials int
    Number of associated credentials
    total_workloads int
    Number of workloads
    trn str
    Workload pool Trn
    updated_at str
    Workload pool update time
    workload_pool_id str
    Workload pool ID
    workload_pool_name str
    Workload pool name
    createdAt String
    Workload pool creation time
    description String
    Workload pool description
    discoveryUrl String
    OIDC discovery endpoint
    projectName String
    Project name
    tags List<Property Map>
    Resource tags. You can categorize instances by tags to facilitate instance search and resource aggregation. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    totalCredentials Number
    Number of associated credentials
    totalWorkloads Number
    Number of workloads
    trn String
    Workload pool Trn
    updatedAt String
    Workload pool update time
    workloadPoolId String
    Workload pool ID
    workloadPoolName String
    Workload pool name

    Supporting Types

    WorkloadPoolTag, WorkloadPoolTagArgs

    Key string
    Tag key
    Value string
    Tag value
    Key string
    Tag key
    Value string
    Tag value
    key string
    Tag key
    value string
    Tag value
    key String
    Tag key
    value String
    Tag value
    key string
    Tag key
    value string
    Tag value
    key str
    Tag key
    value str
    Tag value
    key String
    Tag key
    value String
    Tag value

    Import

    $ pulumi import bytepluscc:id/workloadPool:WorkloadPool example "workload_pool_name"
    

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

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.42
    published on Monday, Jul 20, 2026 by Byteplus

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial