# TestSuite

> Resource TestSuite in pulumi-buildkite.

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

Resource TestSuite in pulumi-buildkite.

Pulumi type: `buildkite:index/testSuite:TestSuite`.

`name` is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

## 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 resource = new buildkite.TestSuite("testSuite", {
  defaultBranch: "<defaultBranch>",
  teamOwnerId: "<teamOwnerId>",
})
```

## Arguments

| Property          | Type     | Required | Description                                                                                                                                                                                                                                                                                                                                                                  |
| ----------------- | -------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `applicationName` | `string` | no       | The name of the application this test suite is for. If omitted, the value is left unmanaged by Terraform; set it to an empty string to clear it.                                                                                                                                                                                                                             |
| `color`           | `string` | no       | The hex color code for the test suite navatar, eg #BADA55. If omitted, the value is left unmanaged by Terraform; set it to an empty string to clear it.                                                                                                                                                                                                                      |
| `defaultBranch`   | `string` | yes      | The default branch for the repository this test suite is for.                                                                                                                                                                                                                                                                                                                |
| `emoji`           | `string` | no       | The emoji associated with this test suite, eg :buildkite:                                                                                                                                                                                                                                                                                                                    |
| `name`            | `string` | no       | The name to give the test suite.                                                                                                                                                                                                                                                                                                                                             |
| `oidcPolicy`      | `string` | no       | The [OIDC policy](https://buildkite.com/docs/pipelines/configure/tests/test-collection/oidc) for the test suite, as a YAML or JSON string. This policy defines which OIDC tokens can be exchanged for suite access, as an alternative to the suite API token. If omitted, the policy is left unmanaged by Terraform; set it to an empty string to remove an existing policy. |
| `teamOwnerId`     | `string` | yes      | The GraphQL ID of the team to mark as the owner/admin of the test suite.                                                                                                                                                                                                                                                                                                     |

## Outputs

Computed outputs are produced by the provider. They are not constructor arguments.

| Property          | Type     | Computed | Description                                                                                                                                                                                                                                                                                                                                                                  |
| ----------------- | -------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `apiToken`        | `string` | yes      | The API token to use to send test run data to the API.                                                                                                                                                                                                                                                                                                                       |
| `applicationName` | `string` | no       | The name of the application this test suite is for. If omitted, the value is left unmanaged by Terraform; set it to an empty string to clear it.                                                                                                                                                                                                                             |
| `color`           | `string` | no       | The hex color code for the test suite navatar, eg #BADA55. If omitted, the value is left unmanaged by Terraform; set it to an empty string to clear it.                                                                                                                                                                                                                      |
| `defaultBranch`   | `string` | no       | The default branch for the repository this test suite is for.                                                                                                                                                                                                                                                                                                                |
| `emoji`           | `string` | no       | The emoji associated with this test suite, eg :buildkite:                                                                                                                                                                                                                                                                                                                    |
| `name`            | `string` | no       | The name to give the test suite.                                                                                                                                                                                                                                                                                                                                             |
| `oidcPolicy`      | `string` | no       | The [OIDC policy](https://buildkite.com/docs/pipelines/configure/tests/test-collection/oidc) for the test suite, as a YAML or JSON string. This policy defines which OIDC tokens can be exchanged for suite access, as an alternative to the suite API token. If omitted, the policy is left unmanaged by Terraform; set it to an empty string to remove an existing policy. |
| `slug`            | `string` | yes      | The generated slug of the test suite.                                                                                                                                                                                                                                                                                                                                        |
| `teamOwnerId`     | `string` | no       | The GraphQL ID of the team to mark as the owner/admin of the test suite.                                                                                                                                                                                                                                                                                                     |
| `uuid`            | `string` | yes      | The UUID of the test suite.                                                                                                                                                                                                                                                                                                                                                  |