# getCluster

> Function getCluster in pulumi-buildkite.

<!-- Generated from the pulumi-buildkite SDK. -->

Function getCluster in pulumi-buildkite.

Invoke token: `buildkite:index/getCluster:getCluster`.

## Example

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

```ts
import * as buildkite from "pulumi-buildkite"

const result = await buildkite.getCluster({
  name: "<name>",
})
```

`getClusterOutput` accepts Input values and returns `Output` of the same result.

## Arguments

| Property | Type     | Required | Description |
| -------- | -------- | -------- | ----------- |
| `name`   | `string` | yes      |             |

## Result

| Property      | Type                     | Always present | Description |
| ------------- | ------------------------ | -------------- | ----------- |
| `color`       | `string`                 | yes            |             |
| `description` | `string`                 | yes            |             |
| `emoji`       | `string`                 | yes            |             |
| `id`          | `string`                 | yes            |             |
| `maintainers` | `GetClusterMaintainer[]` | yes            |             |
| `name`        | `string`                 | yes            |             |
| `uuid`        | `string`                 | yes            |             |

## `GetClusterMaintainer`

Output object `GetClusterMaintainer`. Fields below belong to this object.

| Property         | Type     | Always present | Description                              |
| ---------------- | -------- | -------------- | ---------------------------------------- |
| `actorEmail`     | `string` | yes            | The email of the actor (only for users). |
| `actorName`      | `string` | yes            | The name of the actor.                   |
| `actorSlug`      | `string` | yes            | The slug of the actor (only for teams).  |
| `actorType`      | `string` | yes            | The type of the actor (user or team).    |
| `actorUuid`      | `string` | yes            | The UUID of the actor (user or team).    |
| `permissionUuid` | `string` | yes            | The UUID of the maintainer permission.   |