Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Pulumi Cloud (Pulumi Service provider)
  4. API Docs
  5. api
  6. api/agents
  7. Pool

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-pulumiservice

pulumiservice.api/agents.Pool

pulumiservice logo

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-pulumiservice

    Creates a new agent pool for an organization. Agent pools enable self-hosted deployment agents, allowing organizations to run Pulumi Deployments on their own infrastructure rather than Pulumi-managed infrastructure. This is useful for accessing private networks, meeting compliance requirements, or using custom execution environments. The response includes an access token (agent pool secret) that self-hosted agents use to authenticate when polling for deployment work. This token is only returned once at creation time and cannot be retrieved later.

    Create Pool Resource

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

    Constructor syntax

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

@overload
def Pool(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         description: Optional[str] = None,
         name: Optional[str] = None,
         org_name: Optional[str] = None,
         pool_id: Optional[str] = None)
    func NewPool(ctx *Context, name string, args PoolArgs, opts ...ResourceOption) (*Pool, error)
    public Pool(string name, PoolArgs args, CustomResourceOptions? opts = null)
    public Pool(String name, PoolArgs args)
public Pool(String name, PoolArgs args, CustomResourceOptions options)

    type: pulumiservice:api/agents:Pool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "pulumiservice_api_agents_pool" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args PoolArgs
    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 PoolArgs
    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 PoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PoolArgs
    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 poolResource = new PulumiService.Api.Agents.Pool("poolResource", new()
{
    Description = "string",
    Name = "string",
    OrgName = "string",
    PoolId = "string",
});

    example, err := agents.NewPool(ctx, "poolResource", &agents.PoolArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	OrgName:     pulumi.String("string"),
	PoolId:      pulumi.String("string"),
})

    resource "pulumiservice_api_agents_pool" "poolResource" {
  description = "string"
  name        = "string"
  org_name    = "string"
  pool_id     = "string"
}

    var poolResource = new Pool("poolResource", PoolArgs.builder()
    .description("string")
    .name("string")
    .orgName("string")
    .poolId("string")
    .build());

    pool_resource = pulumiservice.api.agents.Pool("poolResource",
    description="string",
    name="string",
    org_name="string",
    pool_id="string")

    const poolResource = new pulumiservice.api.agents.Pool("poolResource", {
    description: "string",
    name: "string",
    orgName: "string",
    poolId: "string",
});

    type: pulumiservice:api/agents:Pool
properties:
    description: string
    name: string
    orgName: string
    poolId: string

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

    Description string
    The description
    Name string
    The name
    OrgName string
    The organization name
    PoolId string
    The agent pool identifier
    Description string
    The description
    Name string
    The name
    OrgName string
    The organization name
    PoolId string
    The agent pool identifier
    description string
    The description
    name string
    The name
    org_name string
    The organization name
    pool_id string
    The agent pool identifier
    description String
    The description
    name String
    The name
    orgName String
    The organization name
    poolId String
    The agent pool identifier
    description string
    The description
    name string
    The name
    orgName string
    The organization name
    poolId string
    The agent pool identifier
    description str
    The description
    name str
    The name
    org_name str
    The organization name
    pool_id str
    The agent pool identifier
    description String
    The description
    name String
    The name
    orgName String
    The organization name
    poolId String
    The agent pool identifier

    Outputs

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

    Agents List<object>
    The agents
    Created int
    The creation timestamp
    Id string
    The provider-assigned unique ID for this managed resource.
    TokenValue string
    The token value
    Agents []interface{}
    The agents
    Created int
    The creation timestamp
    Id string
    The provider-assigned unique ID for this managed resource.
    TokenValue string
    The token value
    agents list(any)
    The agents
    created number
    The creation timestamp
    id string
    The provider-assigned unique ID for this managed resource.
    token_value string
    The token value
    agents List<Object>
    The agents
    created Integer
    The creation timestamp
    id String
    The provider-assigned unique ID for this managed resource.
    tokenValue String
    The token value
    agents any[]
    The agents
    created number
    The creation timestamp
    id string
    The provider-assigned unique ID for this managed resource.
    tokenValue string
    The token value
    agents Sequence[Any]
    The agents
    created int
    The creation timestamp
    id str
    The provider-assigned unique ID for this managed resource.
    token_value str
    The token value
    agents List<Any>
    The agents
    created Number
    The creation timestamp
    id String
    The provider-assigned unique ID for this managed resource.
    tokenValue String
    The token value

    Package Details

    Repository
    pulumiservice pulumi/pulumi-pulumiservice
    License
    Apache-2.0
    pulumiservice logo

    This provider is currently in preview.

    Viewing docs for Pulumi Cloud v1.1.0
    published on Thursday, May 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-pulumiservice

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial