Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Pulumi Cloud (Pulumi Service provider)
  3. API Docs
  4. AgentPool
Pulumi Cloud v0.27.1 published on Thursday, Nov 14, 2024 by Pulumi
pulumi/pulumi-pulumiservice

pulumiservice.AgentPool

Explore with Pulumi AI

pulumiservice logo
Pulumi Cloud v0.27.1 published on Thursday, Nov 14, 2024 by Pulumi
pulumi/pulumi-pulumiservice

    Agent Pool for customer managed deployments

    Create AgentPool Resource

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

    Constructor syntax

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

@overload
def AgentPool(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              name: Optional[str] = None,
              organization_name: Optional[str] = None,
              description: Optional[str] = None,
              force_destroy: Optional[bool] = None)
    func NewAgentPool(ctx *Context, name string, args AgentPoolArgs, opts ...ResourceOption) (*AgentPool, error)
    public AgentPool(string name, AgentPoolArgs args, CustomResourceOptions? opts = null)
    public AgentPool(String name, AgentPoolArgs args)
public AgentPool(String name, AgentPoolArgs args, CustomResourceOptions options)

    type: pulumiservice:AgentPool
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 AgentPoolArgs
    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 AgentPoolArgs
    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 AgentPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AgentPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AgentPoolArgs
    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 agentPoolResource = new PulumiService.AgentPool("agentPoolResource", new()
{
    Name = "string",
    OrganizationName = "string",
    Description = "string",
    ForceDestroy = false,
});

    example, err := pulumiservice.NewAgentPool(ctx, "agentPoolResource", &pulumiservice.AgentPoolArgs{
	Name:             pulumi.String("string"),
	OrganizationName: pulumi.String("string"),
	Description:      pulumi.String("string"),
	ForceDestroy:     pulumi.Bool(false),
})

    var agentPoolResource = new AgentPool("agentPoolResource", AgentPoolArgs.builder()
    .name("string")
    .organizationName("string")
    .description("string")
    .forceDestroy(false)
    .build());

    agent_pool_resource = pulumiservice.AgentPool("agentPoolResource",
    name="string",
    organization_name="string",
    description="string",
    force_destroy=False)

    const agentPoolResource = new pulumiservice.AgentPool("agentPoolResource", {
    name: "string",
    organizationName: "string",
    description: "string",
    forceDestroy: false,
});

    type: pulumiservice:AgentPool
properties:
    description: string
    forceDestroy: false
    name: string
    organizationName: string

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

    Name string
    Name of the agent pool.
    OrganizationName string
    The organization's name.
    Description string
    Description of the agent pool.
    ForceDestroy bool
    Optional. Flag indicating whether to delete the agent pool even if stacks are configured to use it.
    Name string
    Name of the agent pool.
    OrganizationName string
    The organization's name.
    Description string
    Description of the agent pool.
    ForceDestroy bool
    Optional. Flag indicating whether to delete the agent pool even if stacks are configured to use it.
    name String
    Name of the agent pool.
    organizationName String
    The organization's name.
    description String
    Description of the agent pool.
    forceDestroy Boolean
    Optional. Flag indicating whether to delete the agent pool even if stacks are configured to use it.
    name string
    Name of the agent pool.
    organizationName string
    The organization's name.
    description string
    Description of the agent pool.
    forceDestroy boolean
    Optional. Flag indicating whether to delete the agent pool even if stacks are configured to use it.
    name str
    Name of the agent pool.
    organization_name str
    The organization's name.
    description str
    Description of the agent pool.
    force_destroy bool
    Optional. Flag indicating whether to delete the agent pool even if stacks are configured to use it.
    name String
    Name of the agent pool.
    organizationName String
    The organization's name.
    description String
    Description of the agent pool.
    forceDestroy Boolean
    Optional. Flag indicating whether to delete the agent pool even if stacks are configured to use it.

    Outputs

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

    AgentPoolId string
    The agent pool identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    TokenValue string
    The agent pool's token's value.
    AgentPoolId string
    The agent pool identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    TokenValue string
    The agent pool's token's value.
    agentPoolId String
    The agent pool identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    tokenValue String
    The agent pool's token's value.
    agentPoolId string
    The agent pool identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    tokenValue string
    The agent pool's token's value.
    agent_pool_id str
    The agent pool identifier.
    id str
    The provider-assigned unique ID for this managed resource.
    token_value str
    The agent pool's token's value.
    agentPoolId String
    The agent pool identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    tokenValue String
    The agent pool's token's value.

    Package Details

    Repository
    pulumiservice pulumi/pulumi-pulumiservice
    License
    Apache-2.0
    pulumiservice logo
    Pulumi Cloud v0.27.1 published on Thursday, Nov 14, 2024 by Pulumi
    pulumi/pulumi-pulumiservice