Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Coder Provider
  3. API Docs
  4. ExternalAgent
coder 2.10.1 published on Thursday, Aug 28, 2025 by coder
coder/terraform-provider-coder

coder.ExternalAgent

Explore with Pulumi AI

coder logo
coder 2.10.1 published on Thursday, Aug 28, 2025 by coder
coder/terraform-provider-coder

    Define an external agent to be used in a workspace.

    Warning: External agents require a Premium Coder license.

    Create ExternalAgent Resource

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

    Constructor syntax

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

@overload
def ExternalAgent(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  agent_id: Optional[str] = None,
                  external_agent_id: Optional[str] = None)
    func NewExternalAgent(ctx *Context, name string, args ExternalAgentArgs, opts ...ResourceOption) (*ExternalAgent, error)
    public ExternalAgent(string name, ExternalAgentArgs args, CustomResourceOptions? opts = null)
    public ExternalAgent(String name, ExternalAgentArgs args)
public ExternalAgent(String name, ExternalAgentArgs args, CustomResourceOptions options)

    type: coder:ExternalAgent
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 ExternalAgentArgs
    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 ExternalAgentArgs
    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 ExternalAgentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExternalAgentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExternalAgentArgs
    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 externalAgentResource = new Coder.ExternalAgent("externalAgentResource", new()
{
    AgentId = "string",
    ExternalAgentId = "string",
});

    example, err := coder.NewExternalAgent(ctx, "externalAgentResource", &coder.ExternalAgentArgs{
	AgentId:         pulumi.String("string"),
	ExternalAgentId: pulumi.String("string"),
})

    var externalAgentResource = new ExternalAgent("externalAgentResource", ExternalAgentArgs.builder()
    .agentId("string")
    .externalAgentId("string")
    .build());

    external_agent_resource = coder.ExternalAgent("externalAgentResource",
    agent_id="string",
    external_agent_id="string")

    const externalAgentResource = new coder.ExternalAgent("externalAgentResource", {
    agentId: "string",
    externalAgentId: "string",
});

    type: coder:ExternalAgent
properties:
    agentId: string
    externalAgentId: string

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

    AgentId string
    The id property of a coder.Agent resource to associate with.
    ExternalAgentId string
    The ID of this resource.
    AgentId string
    The id property of a coder.Agent resource to associate with.
    ExternalAgentId string
    The ID of this resource.
    agentId String
    The id property of a coder.Agent resource to associate with.
    externalAgentId String
    The ID of this resource.
    agentId string
    The id property of a coder.Agent resource to associate with.
    externalAgentId string
    The ID of this resource.
    agent_id str
    The id property of a coder.Agent resource to associate with.
    external_agent_id str
    The ID of this resource.
    agentId String
    The id property of a coder.Agent resource to associate with.
    externalAgentId String
    The ID of this resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ExternalAgent Resource

    Get an existing ExternalAgent 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?: ExternalAgentState, opts?: CustomResourceOptions): ExternalAgent
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_id: Optional[str] = None,
        external_agent_id: Optional[str] = None) -> ExternalAgent
    func GetExternalAgent(ctx *Context, name string, id IDInput, state *ExternalAgentState, opts ...ResourceOption) (*ExternalAgent, error)
    public static ExternalAgent Get(string name, Input<string> id, ExternalAgentState? state, CustomResourceOptions? opts = null)
    public static ExternalAgent get(String name, Output<String> id, ExternalAgentState state, CustomResourceOptions options)
    resources:  _:    type: coder:ExternalAgent    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:
    AgentId string
    The id property of a coder.Agent resource to associate with.
    ExternalAgentId string
    The ID of this resource.
    AgentId string
    The id property of a coder.Agent resource to associate with.
    ExternalAgentId string
    The ID of this resource.
    agentId String
    The id property of a coder.Agent resource to associate with.
    externalAgentId String
    The ID of this resource.
    agentId string
    The id property of a coder.Agent resource to associate with.
    externalAgentId string
    The ID of this resource.
    agent_id str
    The id property of a coder.Agent resource to associate with.
    external_agent_id str
    The ID of this resource.
    agentId String
    The id property of a coder.Agent resource to associate with.
    externalAgentId String
    The ID of this resource.

    Package Details

    Repository
    coder coder/terraform-provider-coder
    License
    Notes
    This Pulumi package is based on the coder Terraform Provider.
    coder logo
    coder 2.10.1 published on Thursday, Aug 28, 2025 by coder
    coder/terraform-provider-coder