1. Packages
  2. Buildkite
  3. API Docs
  4. Cluster
  5. getClusters
Viewing docs for Buildkite v3.2.0
published on Monday, Feb 23, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-buildkite

buildkite.Cluster.getClusters

buildkite logo
Viewing docs for Buildkite v3.2.0
published on Monday, Feb 23, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-buildkite

    Use this data source to retrieve clusters of an organization. You can find out more about clusters in the Buildkite documentation.

    Using getClusters

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getClusters(opts?: InvokeOptions): Promise<GetClustersResult>
function getClustersOutput(opts?: InvokeOptions): Output<GetClustersResult>
    def get_clusters(opts: Optional[InvokeOptions] = None) -> GetClustersResult
def get_clusters_output(opts: Optional[InvokeOptions] = None) -> Output[GetClustersResult]
    func GetClusters(ctx *Context, opts ...InvokeOption) (*GetClustersResult, error)
func GetClustersOutput(ctx *Context, opts ...InvokeOption) GetClustersResultOutput

    > Note: This function is named GetClusters in the Go SDK.

    public static class GetClusters 
{
    public static Task<GetClustersResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetClustersResult> Invoke(InvokeOptions? opts = null)
}
    public static CompletableFuture<GetClustersResult> getClusters(InvokeOptions options)
public static Output<GetClustersResult> getClusters(InvokeOptions options)

    fn::invoke:
  function: buildkite:Cluster/getClusters:getClusters
  arguments:
    # arguments dictionary

    getClusters Result

    The following output properties are available:

    Clusters List<Pulumiverse.Buildkite.Cluster.Outputs.GetClustersCluster>
    Id string
    The provider-assigned unique ID for this managed resource.
    Clusters []GetClustersCluster
    Id string
    The provider-assigned unique ID for this managed resource.
    clusters List<Gets>
    id String
    The provider-assigned unique ID for this managed resource.
    clusters GetClustersCluster[]
    id string
    The provider-assigned unique ID for this managed resource.
    clusters Sequence[GetClustersCluster]
    id str
    The provider-assigned unique ID for this managed resource.
    clusters List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GetClustersCluster

    Color string
    The color for the cluster.
    DefaultQueue Pulumiverse.Buildkite.Cluster.Inputs.GetClustersClusterDefaultQueue
    The default queue for the cluster.
    Description string
    The description of the cluster.
    Emoji string
    The emoji for the cluster.
    Id string
    The GraphQL ID of the cluster.
    Maintainers List<Pulumiverse.Buildkite.Cluster.Inputs.GetClustersClusterMaintainer>
    List of maintainers (users and teams) for this cluster.
    Name string
    The name of the cluster.
    Uuid string
    The UUID of the cluster.
    Color string
    The color for the cluster.
    DefaultQueue GetClustersClusterDefaultQueue
    The default queue for the cluster.
    Description string
    The description of the cluster.
    Emoji string
    The emoji for the cluster.
    Id string
    The GraphQL ID of the cluster.
    Maintainers []GetClustersClusterMaintainer
    List of maintainers (users and teams) for this cluster.
    Name string
    The name of the cluster.
    Uuid string
    The UUID of the cluster.
    color String
    The color for the cluster.
    defaultQueue GetsDefaultQueue
    The default queue for the cluster.
    description String
    The description of the cluster.
    emoji String
    The emoji for the cluster.
    id String
    The GraphQL ID of the cluster.
    maintainers List<GetsMaintainer>
    List of maintainers (users and teams) for this cluster.
    name String
    The name of the cluster.
    uuid String
    The UUID of the cluster.
    color string
    The color for the cluster.
    defaultQueue GetClustersClusterDefaultQueue
    The default queue for the cluster.
    description string
    The description of the cluster.
    emoji string
    The emoji for the cluster.
    id string
    The GraphQL ID of the cluster.
    maintainers GetClustersClusterMaintainer[]
    List of maintainers (users and teams) for this cluster.
    name string
    The name of the cluster.
    uuid string
    The UUID of the cluster.
    color str
    The color for the cluster.
    default_queue GetClustersClusterDefaultQueue
    The default queue for the cluster.
    description str
    The description of the cluster.
    emoji str
    The emoji for the cluster.
    id str
    The GraphQL ID of the cluster.
    maintainers Sequence[GetClustersClusterMaintainer]
    List of maintainers (users and teams) for this cluster.
    name str
    The name of the cluster.
    uuid str
    The UUID of the cluster.
    color String
    The color for the cluster.
    defaultQueue Property Map
    The default queue for the cluster.
    description String
    The description of the cluster.
    emoji String
    The emoji for the cluster.
    id String
    The GraphQL ID of the cluster.
    maintainers List<Property Map>
    List of maintainers (users and teams) for this cluster.
    name String
    The name of the cluster.
    uuid String
    The UUID of the cluster.

    GetClustersClusterDefaultQueue

    Description string
    The description of the default queue.
    Id string
    The GraphQL ID of the default queue.
    Key string
    The key of the default queue.
    Uuid string
    The UUID of the default queue.
    Description string
    The description of the default queue.
    Id string
    The GraphQL ID of the default queue.
    Key string
    The key of the default queue.
    Uuid string
    The UUID of the default queue.
    description String
    The description of the default queue.
    id String
    The GraphQL ID of the default queue.
    key String
    The key of the default queue.
    uuid String
    The UUID of the default queue.
    description string
    The description of the default queue.
    id string
    The GraphQL ID of the default queue.
    key string
    The key of the default queue.
    uuid string
    The UUID of the default queue.
    description str
    The description of the default queue.
    id str
    The GraphQL ID of the default queue.
    key str
    The key of the default queue.
    uuid str
    The UUID of the default queue.
    description String
    The description of the default queue.
    id String
    The GraphQL ID of the default queue.
    key String
    The key of the default queue.
    uuid String
    The UUID of the default queue.

    GetClustersClusterMaintainer

    ActorEmail string
    The email of the actor (only for users).
    ActorName string
    The name of the actor.
    ActorSlug string
    The slug of the actor (only for teams).
    ActorType string
    The type of the actor (user or team).
    ActorUuid string
    The UUID of the actor (user or team).
    PermissionUuid string
    The UUID of the maintainer permission.
    ActorEmail string
    The email of the actor (only for users).
    ActorName string
    The name of the actor.
    ActorSlug string
    The slug of the actor (only for teams).
    ActorType string
    The type of the actor (user or team).
    ActorUuid string
    The UUID of the actor (user or team).
    PermissionUuid string
    The UUID of the maintainer permission.
    actorEmail String
    The email of the actor (only for users).
    actorName String
    The name of the actor.
    actorSlug String
    The slug of the actor (only for teams).
    actorType String
    The type of the actor (user or team).
    actorUuid String
    The UUID of the actor (user or team).
    permissionUuid String
    The UUID of the maintainer permission.
    actorEmail string
    The email of the actor (only for users).
    actorName string
    The name of the actor.
    actorSlug string
    The slug of the actor (only for teams).
    actorType string
    The type of the actor (user or team).
    actorUuid string
    The UUID of the actor (user or team).
    permissionUuid string
    The UUID of the maintainer permission.
    actor_email str
    The email of the actor (only for users).
    actor_name str
    The name of the actor.
    actor_slug str
    The slug of the actor (only for teams).
    actor_type str
    The type of the actor (user or team).
    actor_uuid str
    The UUID of the actor (user or team).
    permission_uuid str
    The UUID of the maintainer permission.
    actorEmail String
    The email of the actor (only for users).
    actorName String
    The name of the actor.
    actorSlug String
    The slug of the actor (only for teams).
    actorType String
    The type of the actor (user or team).
    actorUuid String
    The UUID of the actor (user or team).
    permissionUuid String
    The UUID of the maintainer permission.

    Package Details

    Repository
    buildkite pulumiverse/pulumi-buildkite
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the buildkite Terraform Provider.
    buildkite logo
    Viewing docs for Buildkite v3.2.0
    published on Monday, Feb 23, 2026 by Pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-buildkite
      Try Pulumi Cloud free. Your team will thank you.