@pulumi/pulumiservice/api/agents/pool.d.ts

[](https://slack.pulumi.com) [](https://www.npmjs.com/package/@pulumi/pulumiservice) [![Python version](https://badge.fury.io

import * as pulumi from "@pulumi/pulumi";
/**
 * 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.
 */
export declare class Pool extends pulumi.CustomResource {
    /**
     * Get an existing Pool resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Pool;
    /**
     * Returns true if the given object is an instance of Pool.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Pool;
    /**
     * The agents
     */
    readonly agents: pulumi.Output<any[]>;
    /**
     * The creation timestamp
     */
    readonly created: pulumi.Output<number>;
    /**
     * The description
     */
    readonly description: pulumi.Output<string>;
    /**
     * The name
     */
    readonly name: pulumi.Output<string>;
    /**
     * The unique identifier
     */
    readonly poolId: pulumi.Output<string>;
    /**
     * The token value
     */
    readonly tokenValue: pulumi.Output<string | undefined>;
    /**
     * Create a Pool resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: PoolArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * The set of arguments for constructing a Pool resource.
 */
export interface PoolArgs {
    /**
     * The description
     */
    description: pulumi.Input<string>;
    /**
     * The name
     */
    name: pulumi.Input<string>;
    /**
     * The organization name
     */
    orgName: pulumi.Input<string>;
    /**
     * The agent pool identifier
     */
    poolId?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=pool.d.ts.map