Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. DynamicWorkerPool
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.DynamicWorkerPool

Explore with Pulumi AI

octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

This resource manages dynamic worker pools in Octopus Deploy.

Example Usage

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

const example = new octopusdeploy.DynamicWorkerPool("example", {
    description: "Description for the dynamic worker pool.",
    isDefault: true,
    sortOrder: 5,
    workerType: "UbuntuDefault",
});
Copy
import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.DynamicWorkerPool("example",
    description="Description for the dynamic worker pool.",
    is_default=True,
    sort_order=5,
    worker_type="UbuntuDefault")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/octopusdeploy/octopusdeploy"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := octopusdeploy.NewDynamicWorkerPool(ctx, "example", &octopusdeploy.DynamicWorkerPoolArgs{
			Description: pulumi.String("Description for the dynamic worker pool."),
			IsDefault:   pulumi.Bool(true),
			SortOrder:   pulumi.Float64(5),
			WorkerType:  pulumi.String("UbuntuDefault"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Octopusdeploy = Pulumi.Octopusdeploy;

return await Deployment.RunAsync(() => 
{
    var example = new Octopusdeploy.DynamicWorkerPool("example", new()
    {
        Description = "Description for the dynamic worker pool.",
        IsDefault = true,
        SortOrder = 5,
        WorkerType = "UbuntuDefault",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.DynamicWorkerPool;
import com.pulumi.octopusdeploy.DynamicWorkerPoolArgs;
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 example = new DynamicWorkerPool("example", DynamicWorkerPoolArgs.builder()
            .description("Description for the dynamic worker pool.")
            .isDefault(true)
            .sortOrder(5)
            .workerType("UbuntuDefault")
            .build());

    }
}
Copy
resources:
  example:
    type: octopusdeploy:DynamicWorkerPool
    properties:
      description: Description for the dynamic worker pool.
      isDefault: true
      sortOrder: 5
      workerType: UbuntuDefault
Copy

Create DynamicWorkerPool Resource

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

Constructor syntax

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

@overload
def DynamicWorkerPool(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      worker_type: Optional[str] = None,
                      description: Optional[str] = None,
                      dynamic_worker_pool_id: Optional[str] = None,
                      is_default: Optional[bool] = None,
                      name: Optional[str] = None,
                      sort_order: Optional[float] = None,
                      space_id: Optional[str] = None)
func NewDynamicWorkerPool(ctx *Context, name string, args DynamicWorkerPoolArgs, opts ...ResourceOption) (*DynamicWorkerPool, error)
public DynamicWorkerPool(string name, DynamicWorkerPoolArgs args, CustomResourceOptions? opts = null)
public DynamicWorkerPool(String name, DynamicWorkerPoolArgs args)
public DynamicWorkerPool(String name, DynamicWorkerPoolArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DynamicWorkerPoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DynamicWorkerPoolArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DynamicWorkerPoolArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DynamicWorkerPoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DynamicWorkerPoolArgs
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 dynamicWorkerPoolResource = new Octopusdeploy.DynamicWorkerPool("dynamicWorkerPoolResource", new()
{
    WorkerType = "string",
    Description = "string",
    DynamicWorkerPoolId = "string",
    IsDefault = false,
    Name = "string",
    SortOrder = 0,
    SpaceId = "string",
});
Copy
example, err := octopusdeploy.NewDynamicWorkerPool(ctx, "dynamicWorkerPoolResource", &octopusdeploy.DynamicWorkerPoolArgs{
	WorkerType:          pulumi.String("string"),
	Description:         pulumi.String("string"),
	DynamicWorkerPoolId: pulumi.String("string"),
	IsDefault:           pulumi.Bool(false),
	Name:                pulumi.String("string"),
	SortOrder:           pulumi.Float64(0),
	SpaceId:             pulumi.String("string"),
})
Copy
var dynamicWorkerPoolResource = new DynamicWorkerPool("dynamicWorkerPoolResource", DynamicWorkerPoolArgs.builder()
    .workerType("string")
    .description("string")
    .dynamicWorkerPoolId("string")
    .isDefault(false)
    .name("string")
    .sortOrder(0)
    .spaceId("string")
    .build());
Copy
dynamic_worker_pool_resource = octopusdeploy.DynamicWorkerPool("dynamicWorkerPoolResource",
    worker_type="string",
    description="string",
    dynamic_worker_pool_id="string",
    is_default=False,
    name="string",
    sort_order=0,
    space_id="string")
Copy
const dynamicWorkerPoolResource = new octopusdeploy.DynamicWorkerPool("dynamicWorkerPoolResource", {
    workerType: "string",
    description: "string",
    dynamicWorkerPoolId: "string",
    isDefault: false,
    name: "string",
    sortOrder: 0,
    spaceId: "string",
});
Copy
type: octopusdeploy:DynamicWorkerPool
properties:
    description: string
    dynamicWorkerPoolId: string
    isDefault: false
    name: string
    sortOrder: 0
    spaceId: string
    workerType: string
Copy

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

WorkerType This property is required. string
Description string
The description of this dynamic worker pool.
DynamicWorkerPoolId string
The unique ID for this resource.
IsDefault bool
Name string
The name of this resource.
SortOrder double
The order number to sort a dynamic worker pool.
SpaceId string
The space ID associated with this resource.
WorkerType This property is required. string
Description string
The description of this dynamic worker pool.
DynamicWorkerPoolId string
The unique ID for this resource.
IsDefault bool
Name string
The name of this resource.
SortOrder float64
The order number to sort a dynamic worker pool.
SpaceId string
The space ID associated with this resource.
workerType This property is required. String
description String
The description of this dynamic worker pool.
dynamicWorkerPoolId String
The unique ID for this resource.
isDefault Boolean
name String
The name of this resource.
sortOrder Double
The order number to sort a dynamic worker pool.
spaceId String
The space ID associated with this resource.
workerType This property is required. string
description string
The description of this dynamic worker pool.
dynamicWorkerPoolId string
The unique ID for this resource.
isDefault boolean
name string
The name of this resource.
sortOrder number
The order number to sort a dynamic worker pool.
spaceId string
The space ID associated with this resource.
worker_type This property is required. str
description str
The description of this dynamic worker pool.
dynamic_worker_pool_id str
The unique ID for this resource.
is_default bool
name str
The name of this resource.
sort_order float
The order number to sort a dynamic worker pool.
space_id str
The space ID associated with this resource.
workerType This property is required. String
description String
The description of this dynamic worker pool.
dynamicWorkerPoolId String
The unique ID for this resource.
isDefault Boolean
name String
The name of this resource.
sortOrder Number
The order number to sort a dynamic worker pool.
spaceId String
The space ID associated with this resource.

Outputs

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

CanAddWorkers bool
Id string
The provider-assigned unique ID for this managed resource.
CanAddWorkers bool
Id string
The provider-assigned unique ID for this managed resource.
canAddWorkers Boolean
id String
The provider-assigned unique ID for this managed resource.
canAddWorkers boolean
id string
The provider-assigned unique ID for this managed resource.
can_add_workers bool
id str
The provider-assigned unique ID for this managed resource.
canAddWorkers Boolean
id String
The provider-assigned unique ID for this managed resource.

Look up Existing DynamicWorkerPool Resource

Get an existing DynamicWorkerPool 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?: DynamicWorkerPoolState, opts?: CustomResourceOptions): DynamicWorkerPool
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        can_add_workers: Optional[bool] = None,
        description: Optional[str] = None,
        dynamic_worker_pool_id: Optional[str] = None,
        is_default: Optional[bool] = None,
        name: Optional[str] = None,
        sort_order: Optional[float] = None,
        space_id: Optional[str] = None,
        worker_type: Optional[str] = None) -> DynamicWorkerPool
func GetDynamicWorkerPool(ctx *Context, name string, id IDInput, state *DynamicWorkerPoolState, opts ...ResourceOption) (*DynamicWorkerPool, error)
public static DynamicWorkerPool Get(string name, Input<string> id, DynamicWorkerPoolState? state, CustomResourceOptions? opts = null)
public static DynamicWorkerPool get(String name, Output<String> id, DynamicWorkerPoolState state, CustomResourceOptions options)
resources:  _:    type: octopusdeploy:DynamicWorkerPool    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CanAddWorkers bool
Description string
The description of this dynamic worker pool.
DynamicWorkerPoolId string
The unique ID for this resource.
IsDefault bool
Name string
The name of this resource.
SortOrder double
The order number to sort a dynamic worker pool.
SpaceId string
The space ID associated with this resource.
WorkerType string
CanAddWorkers bool
Description string
The description of this dynamic worker pool.
DynamicWorkerPoolId string
The unique ID for this resource.
IsDefault bool
Name string
The name of this resource.
SortOrder float64
The order number to sort a dynamic worker pool.
SpaceId string
The space ID associated with this resource.
WorkerType string
canAddWorkers Boolean
description String
The description of this dynamic worker pool.
dynamicWorkerPoolId String
The unique ID for this resource.
isDefault Boolean
name String
The name of this resource.
sortOrder Double
The order number to sort a dynamic worker pool.
spaceId String
The space ID associated with this resource.
workerType String
canAddWorkers boolean
description string
The description of this dynamic worker pool.
dynamicWorkerPoolId string
The unique ID for this resource.
isDefault boolean
name string
The name of this resource.
sortOrder number
The order number to sort a dynamic worker pool.
spaceId string
The space ID associated with this resource.
workerType string
can_add_workers bool
description str
The description of this dynamic worker pool.
dynamic_worker_pool_id str
The unique ID for this resource.
is_default bool
name str
The name of this resource.
sort_order float
The order number to sort a dynamic worker pool.
space_id str
The space ID associated with this resource.
worker_type str
canAddWorkers Boolean
description String
The description of this dynamic worker pool.
dynamicWorkerPoolId String
The unique ID for this resource.
isDefault Boolean
name String
The name of this resource.
sortOrder Number
The order number to sort a dynamic worker pool.
spaceId String
The space ID associated with this resource.
workerType String

Package Details

Repository
octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
License
Notes
This Pulumi package is based on the octopusdeploy Terraform Provider.
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy