1. Packages
  2. Buildkite
  3. API Docs
  4. Cluster
  5. ClusterAgentToken
Buildkite v2.3.1 published on Monday, Sep 11, 2023 by Pulumiverse

buildkite.Cluster.ClusterAgentToken

Explore with Pulumi AI

buildkite logo
Buildkite v2.3.1 published on Monday, Sep 11, 2023 by Pulumiverse

    # Resource: cluster_agent_token

    This resource allows you to create and manage cluster agent tokens.

    Buildkite Documentation: https://buildkite.com/docs/clusters/manage-clusters#set-up-clusters-connect-agents-to-a-cluster

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Buildkite = Pulumiverse.Buildkite;
    
    return await Deployment.RunAsync(() => 
    {
        var cluster_token_1 = new Buildkite.Cluster.ClusterAgentToken("cluster-token-1", new()
        {
            ClusterId = "Q2x1c3Rlci0tLTkyMmVjOTA4LWRmNWItNDhhYS1hMThjLTczMzE0YjQ1ZGYyMA==",
            Description = "agent token for cluster-1",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-buildkite/sdk/v2/go/buildkite/Cluster"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Cluster.NewClusterAgentToken(ctx, "cluster-token-1", &Cluster.ClusterAgentTokenArgs{
    			ClusterId:   pulumi.String("Q2x1c3Rlci0tLTkyMmVjOTA4LWRmNWItNDhhYS1hMThjLTczMzE0YjQ1ZGYyMA=="),
    			Description: pulumi.String("agent token for cluster-1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.buildkite.Cluster.ClusterAgentToken;
    import com.pulumi.buildkite.Cluster.ClusterAgentTokenArgs;
    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 cluster_token_1 = new ClusterAgentToken("cluster-token-1", ClusterAgentTokenArgs.builder()        
                .clusterId("Q2x1c3Rlci0tLTkyMmVjOTA4LWRmNWItNDhhYS1hMThjLTczMzE0YjQ1ZGYyMA==")
                .description("agent token for cluster-1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumiverse_buildkite as buildkite
    
    cluster_token_1 = buildkite.cluster.ClusterAgentToken("cluster-token-1",
        cluster_id="Q2x1c3Rlci0tLTkyMmVjOTA4LWRmNWItNDhhYS1hMThjLTczMzE0YjQ1ZGYyMA==",
        description="agent token for cluster-1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as buildkite from "@pulumiverse/buildkite";
    
    const cluster_token_1 = new buildkite.cluster.ClusterAgentToken("cluster-token-1", {
        clusterId: "Q2x1c3Rlci0tLTkyMmVjOTA4LWRmNWItNDhhYS1hMThjLTczMzE0YjQ1ZGYyMA==",
        description: "agent token for cluster-1",
    });
    
    resources:
      cluster-token-1:
        type: buildkite:Cluster:ClusterAgentToken
        properties:
          clusterId: Q2x1c3Rlci0tLTkyMmVjOTA4LWRmNWItNDhhYS1hMThjLTczMzE0YjQ1ZGYyMA==
          description: agent token for cluster-1
    

    Create ClusterAgentToken Resource

    new ClusterAgentToken(name: string, args: ClusterAgentTokenArgs, opts?: CustomResourceOptions);
    @overload
    def ClusterAgentToken(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          cluster_id: Optional[str] = None,
                          description: Optional[str] = None)
    @overload
    def ClusterAgentToken(resource_name: str,
                          args: ClusterAgentTokenArgs,
                          opts: Optional[ResourceOptions] = None)
    func NewClusterAgentToken(ctx *Context, name string, args ClusterAgentTokenArgs, opts ...ResourceOption) (*ClusterAgentToken, error)
    public ClusterAgentToken(string name, ClusterAgentTokenArgs args, CustomResourceOptions? opts = null)
    public ClusterAgentToken(String name, ClusterAgentTokenArgs args)
    public ClusterAgentToken(String name, ClusterAgentTokenArgs args, CustomResourceOptions options)
    
    type: buildkite:Cluster:ClusterAgentToken
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args ClusterAgentTokenArgs
    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 ClusterAgentTokenArgs
    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 ClusterAgentTokenArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterAgentTokenArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterAgentTokenArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ClusterAgentToken Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ClusterAgentToken resource accepts the following input properties:

    ClusterId string

    The ID of the cluster that this cluster queue belongs to.

    Description string

    A description about what this cluster agent token is used for.

    ClusterId string

    The ID of the cluster that this cluster queue belongs to.

    Description string

    A description about what this cluster agent token is used for.

    clusterId String

    The ID of the cluster that this cluster queue belongs to.

    description String

    A description about what this cluster agent token is used for.

    clusterId string

    The ID of the cluster that this cluster queue belongs to.

    description string

    A description about what this cluster agent token is used for.

    cluster_id str

    The ID of the cluster that this cluster queue belongs to.

    description str

    A description about what this cluster agent token is used for.

    clusterId String

    The ID of the cluster that this cluster queue belongs to.

    description String

    A description about what this cluster agent token is used for.

    Outputs

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

    ClusterUuid string

    The UUID of the cluster that this cluster queue belongs to.

    Id string

    The provider-assigned unique ID for this managed resource.

    Token string
    Uuid string

    The UUID of the created cluster queue.

    ClusterUuid string

    The UUID of the cluster that this cluster queue belongs to.

    Id string

    The provider-assigned unique ID for this managed resource.

    Token string
    Uuid string

    The UUID of the created cluster queue.

    clusterUuid String

    The UUID of the cluster that this cluster queue belongs to.

    id String

    The provider-assigned unique ID for this managed resource.

    token String
    uuid String

    The UUID of the created cluster queue.

    clusterUuid string

    The UUID of the cluster that this cluster queue belongs to.

    id string

    The provider-assigned unique ID for this managed resource.

    token string
    uuid string

    The UUID of the created cluster queue.

    cluster_uuid str

    The UUID of the cluster that this cluster queue belongs to.

    id str

    The provider-assigned unique ID for this managed resource.

    token str
    uuid str

    The UUID of the created cluster queue.

    clusterUuid String

    The UUID of the cluster that this cluster queue belongs to.

    id String

    The provider-assigned unique ID for this managed resource.

    token String
    uuid String

    The UUID of the created cluster queue.

    Look up Existing ClusterAgentToken Resource

    Get an existing ClusterAgentToken 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?: ClusterAgentTokenState, opts?: CustomResourceOptions): ClusterAgentToken
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cluster_id: Optional[str] = None,
            cluster_uuid: Optional[str] = None,
            description: Optional[str] = None,
            token: Optional[str] = None,
            uuid: Optional[str] = None) -> ClusterAgentToken
    func GetClusterAgentToken(ctx *Context, name string, id IDInput, state *ClusterAgentTokenState, opts ...ResourceOption) (*ClusterAgentToken, error)
    public static ClusterAgentToken Get(string name, Input<string> id, ClusterAgentTokenState? state, CustomResourceOptions? opts = null)
    public static ClusterAgentToken get(String name, Output<String> id, ClusterAgentTokenState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    ClusterId string

    The ID of the cluster that this cluster queue belongs to.

    ClusterUuid string

    The UUID of the cluster that this cluster queue belongs to.

    Description string

    A description about what this cluster agent token is used for.

    Token string
    Uuid string

    The UUID of the created cluster queue.

    ClusterId string

    The ID of the cluster that this cluster queue belongs to.

    ClusterUuid string

    The UUID of the cluster that this cluster queue belongs to.

    Description string

    A description about what this cluster agent token is used for.

    Token string
    Uuid string

    The UUID of the created cluster queue.

    clusterId String

    The ID of the cluster that this cluster queue belongs to.

    clusterUuid String

    The UUID of the cluster that this cluster queue belongs to.

    description String

    A description about what this cluster agent token is used for.

    token String
    uuid String

    The UUID of the created cluster queue.

    clusterId string

    The ID of the cluster that this cluster queue belongs to.

    clusterUuid string

    The UUID of the cluster that this cluster queue belongs to.

    description string

    A description about what this cluster agent token is used for.

    token string
    uuid string

    The UUID of the created cluster queue.

    cluster_id str

    The ID of the cluster that this cluster queue belongs to.

    cluster_uuid str

    The UUID of the cluster that this cluster queue belongs to.

    description str

    A description about what this cluster agent token is used for.

    token str
    uuid str

    The UUID of the created cluster queue.

    clusterId String

    The ID of the cluster that this cluster queue belongs to.

    clusterUuid String

    The UUID of the cluster that this cluster queue belongs to.

    description String

    A description about what this cluster agent token is used for.

    token String
    uuid String

    The UUID of the created cluster queue.

    Package Details

    Repository
    buildkite pulumiverse/pulumi-buildkite
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the buildkite Terraform Provider.

    buildkite logo
    Buildkite v2.3.1 published on Monday, Sep 11, 2023 by Pulumiverse