@pulumiverse/buildkite 2.3.0 → 3.0.1

package/pipeline/pipeline.d.ts

@@ -2,121 +2,19 @@ import * as pulumi from "@pulumi/pulumi";
 import * as inputs from "../types/input";
 import * as outputs from "../types/output";
 /**
- * ## # Resource: pipeline
- *
  * This resource allows you to create and manage pipelines for repositories.
  *
- * Buildkite Documentation: https://buildkite.com/docs/pipelines
- *
- * ## Example Usage
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as buildkite from "@pulumiverse/buildkite";
- * import * as fs from "fs";
- *
- * // in ./steps.yml:
- * // steps:
- * //   - label: ':pipeline:'
- * //     command: buildkite-agent pipeline upload
- * const repo2 = new buildkite.pipeline.Pipeline("repo2", {
- *     repository: "git@github.com:org/repo2",
- *     steps: fs.readFileSync("./steps.yml"),
- *     teams: [{
- *         slug: "everyone",
- *         accessLevel: "READ_ONLY",
- *     }],
- * });
- * ```
- * ### With Command Timeouts
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as buildkite from "@pulumiverse/buildkite";
- * import * as fs from "fs";
- *
- * const testNew = new buildkite.pipeline.Pipeline("testNew", {
- *     repository: "https://github.com/buildkite/terraform-provider-buildkite.git",
- *     steps: fs.readFileSync("./deploy-steps.yml"),
- *     defaultTimeoutInMinutes: 60,
- *     maximumTimeoutInMinutes: 120,
- * });
- * ```
- *
- * Currently, the `defaultTimeoutInMinutes` and `maximumTimeoutInMinutes` will be retained in state even if removed from the configuration. In order to remove them, you must set them to `0` in either the configuration or the web UI.
- * ### With Deletion Protection
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as buildkite from "@pulumiverse/buildkite";
- * import * as fs from "fs";
- *
- * const testNew = new buildkite.pipeline.Pipeline("testNew", {
- *     repository: "https://github.com/buildkite/terraform-provider-buildkite.git",
- *     steps: fs.readFileSync("./deploy-steps.yml"),
- *     deletionProtection: true,
- * });
- * ```
- *
- * `deletionProtection` will block `destroy` actions on the **pipeline**. Attached resources, such as `schedules` will still be destroyed.
- * ### With Archive On Delete
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as buildkite from "@pulumiverse/buildkite";
- * import * as fs from "fs";
- *
- * const testNew = new buildkite.pipeline.Pipeline("testNew", {
- *     repository: "https://github.com/buildkite/terraform-provider-buildkite.git",
- *     steps: fs.readFileSync("./deploy-steps.yml"),
- *     archiveOnDelete: true,
- * });
- * ```
- *
- * `archiveOnDelete` will archive the **pipeline** when `destroy` is called. Attached resources, such as `schedules` will still be destroyed. In order to delete the pipeline, `archiveOnDelete` must be set to `false` in the configuration, then `destroy` must be called again.
- * ### With GitHub Provider Settings
- *
- * ```typescript
- * import * as pulumi from "@pulumi/pulumi";
- * import * as buildkite from "@pulumiverse/buildkite";
- * import * as fs from "fs";
- *
- * // Pipeline that should not be triggered from a GitHub webhook
- * const repo2_deploy = new buildkite.pipeline.Pipeline("repo2-deploy", {
- *     repository: "git@github.com:org/repo2",
- *     steps: fs.readFileSync("./deploy-steps.yml"),
- *     providerSettings: {
- *         triggerMode: "none",
- *     },
- * });
- * // Release pipeline (triggered only when tags are pushed)
- * const repo2_release = new buildkite.pipeline.Pipeline("repo2-release", {
- *     repository: "git@github.com:org/repo2",
- *     steps: fs.readFileSync("./release-steps.yml"),
- *     providerSettings: {
- *         buildBranches: false,
- *         buildTags: true,
- *         buildPullRequests: false,
- *         triggerMode: "code",
- *     },
- * });
- * ```
+ * More information on pipelines can be found in the [documentation](https://buildkite.com/docs/pipelines).
  *
  * ## Import
  *
- * Pipelines can be imported using the `GraphQL ID` (not UUID), e.g.
+ * import a pipeline resource using the pipelines GraphQL ID
+ *
+ *  GraphQL ID for a pipeline can be found on its settings page
  *
  * ```sh
- *  $ pulumi import buildkite:Pipeline/pipeline:Pipeline fleet UGlwZWxpbmUtLS00MzVjYWQ1OC1lODFkLTQ1YWYtODYzNy1iMWNmODA3MDIzOGQ=
+ * $ pulumi import buildkite:Pipeline/pipeline:Pipeline pipeline UGlwZWxpbmUtLS00MzVjYWQ1OC1lODFkLTQ1YWYtODYzNy1iMWNmODA3MDIzOGQ=
  * ```
- *
- *  To find the ID to use, you can use the GraphQL query below. Alternatively, you could use this [pre-saved query](https://buildkite.com/user/graphql/console/04e6ac1d-222e-49f9-8167-4767ab0f5362). graphql query getPipelineId {
- *
- *  pipeline(slug"ORGANIZATION_SLUG/PIPELINE_SLUG") {
- *
- *  id
- *
- *  } }
  */
 export declare class Pipeline extends pulumi.CustomResource {
     /**
@@ -135,85 +33,99 @@ export declare class Pipeline extends pulumi.CustomResource {
      */
     static isInstance(obj: any): obj is Pipeline;
     /**
-     * A boolean on whether or not to allow rebuilds for the pipeline.
+     * Whether rebuilds are allowed for this pipeline.
      */
-    readonly allowRebuilds: pulumi.Output<boolean | undefined>;
-    readonly archiveOnDelete: pulumi.Output<boolean | undefined>;
+    readonly allowRebuilds: pulumi.Output<boolean>;
     /**
-     * The pipeline's last build status so you can display build status badge.
+     * The badge URL showing build state.
      */
     readonly badgeUrl: pulumi.Output<string>;
     /**
-     * Limit which branches and tags cause new builds to be created, either via a code push or via the Builds REST API.
+     * Configure the pipeline to only build on this branch conditional.
      */
     readonly branchConfiguration: pulumi.Output<string | undefined>;
     /**
-     * A boolean to enable automatically cancelling any running builds on the same branch when a new build is created.
+     * Whether to cancel builds when a new commit is pushed to a matching branch.
      */
     readonly cancelIntermediateBuilds: pulumi.Output<boolean>;
     /**
-     * Limit which branches build cancelling applies to, for example !master will ensure that the master branch won't have its builds automatically cancelled.
+     * Filter the `cancel_intermediate_builds` setting based on this branch condition.
      */
     readonly cancelIntermediateBuildsBranchFilter: pulumi.Output<string>;
     /**
-     * The GraphQL ID of the cluster you want to use for the pipeline.
+     * Attach this pipeline to the given cluster GraphQL ID.
      */
     readonly clusterId: pulumi.Output<string | undefined>;
     /**
-     * The default branch to prefill when new builds are created or triggered, usually main or master but can be anything.
+     * A color hex code to represent this pipeline.
+     */
+    readonly color: pulumi.Output<string | undefined>;
+    /**
+     * Default branch of the pipeline.
      */
     readonly defaultBranch: pulumi.Output<string>;
     /**
-     * The default timeout for commands in this pipeline, in minutes.
+     * The GraphQL ID of the team to use as the default owner of the pipeline.
      */
-    readonly defaultTimeoutInMinutes: pulumi.Output<number>;
+    readonly defaultTeamId: pulumi.Output<string | undefined>;
     /**
-     * Set to either `true` or `false`. When set to `true`, `destroy` actions on a pipeline will be blocked and fail with a message "Deletion protection is enabled for pipeline: <pipeline name>"
+     * Set pipeline wide timeout for command steps.
      */
-    readonly deletionProtection: pulumi.Output<boolean | undefined>;
+    readonly defaultTimeoutInMinutes: pulumi.Output<number>;
     /**
-     * A description of the pipeline.
+     * Description for the pipeline. Can include emoji 🙌.
      */
     readonly description: pulumi.Output<string>;
     /**
-     * The maximum timeout for commands in this pipeline, in minutes.
+     * An emoji that represents this pipeline.
+     */
+    readonly emoji: pulumi.Output<string | undefined>;
+    /**
+     * Set pipeline wide maximum timeout for command steps.
      */
     readonly maximumTimeoutInMinutes: pulumi.Output<number>;
     /**
-     * The name of the pipeline.
+     * Name to give the pipeline.
      */
     readonly name: pulumi.Output<string>;
     /**
-     * Source control provider settings for the pipeline. See Provider Settings Configuration below for details.
+     * The GraphQL ID of the pipeline template applied to this pipeline.
      */
-    readonly providerSettings: pulumi.Output<outputs.Pipeline.PipelineProviderSettings>;
+    readonly pipelineTemplateId: pulumi.Output<string | undefined>;
     /**
-     * The git URL of the repository.
+     * Control settings depending on the VCS provider used in `repository`.
+     */
+    readonly providerSettings: pulumi.Output<outputs.Pipeline.PipelineProviderSettings | undefined>;
+    /**
+     * URL to the repository this pipeline is configured for.
      */
     readonly repository: pulumi.Output<string>;
     /**
-     * A boolean to enable automatically skipping any unstarted builds on the same branch when a new build is created.
+     * Whether to skip queued builds if a new commit is pushed to a matching branch.
      */
     readonly skipIntermediateBuilds: pulumi.Output<boolean>;
     /**
-     * Limit which branches build skipping applies to, for example `!master` will ensure that the master branch won't have its builds automatically skipped.
+     * Filter the `skip_intermediate_builds` setting based on this branch condition.
      */
     readonly skipIntermediateBuildsBranchFilter: pulumi.Output<string>;
     /**
-     * The buildkite slug of the team.
+     * The slug generated for the pipeline.
      */
     readonly slug: pulumi.Output<string>;
     /**
-     * The string YAML steps to run the pipeline. Defaults to `buildkite-agent pipeline upload` if not specified.
+     * The YAML steps to configure for the pipeline. Defaults to `buildkite-agent pipeline upload`.
+     */
+    readonly steps: pulumi.Output<string>;
+    /**
+     * Tags to attribute to the pipeline. Useful for searching by in the UI.
      */
-    readonly steps: pulumi.Output<string | undefined>;
-    readonly tags: pulumi.Output<string[] | undefined>;
+    readonly tags: pulumi.Output<string[]>;
     /**
-     * Set team access for the pipeline. Can be specified multiple times for each team. See Teams Configuration below for details.
+     * The UUID of the pipeline.
      */
-    readonly teams: pulumi.Output<outputs.Pipeline.PipelineTeam[] | undefined>;
+    readonly uuid: pulumi.Output<string>;
     /**
-     * The Buildkite webhook URL to configure on the repository to trigger builds on this pipeline.
+     * The webhook URL used to trigger builds from VCS providers.
      */
     readonly webhookUrl: pulumi.Output<string>;
     /**
@@ -230,85 +142,99 @@ export declare class Pipeline extends pulumi.CustomResource {
  */
 export interface PipelineState {
     /**
-     * A boolean on whether or not to allow rebuilds for the pipeline.
+     * Whether rebuilds are allowed for this pipeline.
      */
     allowRebuilds?: pulumi.Input<boolean>;
-    archiveOnDelete?: pulumi.Input<boolean>;
     /**
-     * The pipeline's last build status so you can display build status badge.
+     * The badge URL showing build state.
      */
     badgeUrl?: pulumi.Input<string>;
     /**
-     * Limit which branches and tags cause new builds to be created, either via a code push or via the Builds REST API.
+     * Configure the pipeline to only build on this branch conditional.
      */
     branchConfiguration?: pulumi.Input<string>;
     /**
-     * A boolean to enable automatically cancelling any running builds on the same branch when a new build is created.
+     * Whether to cancel builds when a new commit is pushed to a matching branch.
      */
     cancelIntermediateBuilds?: pulumi.Input<boolean>;
     /**
-     * Limit which branches build cancelling applies to, for example !master will ensure that the master branch won't have its builds automatically cancelled.
+     * Filter the `cancel_intermediate_builds` setting based on this branch condition.
      */
     cancelIntermediateBuildsBranchFilter?: pulumi.Input<string>;
     /**
-     * The GraphQL ID of the cluster you want to use for the pipeline.
+     * Attach this pipeline to the given cluster GraphQL ID.
      */
     clusterId?: pulumi.Input<string>;
     /**
-     * The default branch to prefill when new builds are created or triggered, usually main or master but can be anything.
+     * A color hex code to represent this pipeline.
+     */
+    color?: pulumi.Input<string>;
+    /**
+     * Default branch of the pipeline.
      */
     defaultBranch?: pulumi.Input<string>;
     /**
-     * The default timeout for commands in this pipeline, in minutes.
+     * The GraphQL ID of the team to use as the default owner of the pipeline.
      */
-    defaultTimeoutInMinutes?: pulumi.Input<number>;
+    defaultTeamId?: pulumi.Input<string>;
     /**
-     * Set to either `true` or `false`. When set to `true`, `destroy` actions on a pipeline will be blocked and fail with a message "Deletion protection is enabled for pipeline: <pipeline name>"
+     * Set pipeline wide timeout for command steps.
      */
-    deletionProtection?: pulumi.Input<boolean>;
+    defaultTimeoutInMinutes?: pulumi.Input<number>;
     /**
-     * A description of the pipeline.
+     * Description for the pipeline. Can include emoji 🙌.
      */
     description?: pulumi.Input<string>;
     /**
-     * The maximum timeout for commands in this pipeline, in minutes.
+     * An emoji that represents this pipeline.
+     */
+    emoji?: pulumi.Input<string>;
+    /**
+     * Set pipeline wide maximum timeout for command steps.
      */
     maximumTimeoutInMinutes?: pulumi.Input<number>;
     /**
-     * The name of the pipeline.
+     * Name to give the pipeline.
      */
     name?: pulumi.Input<string>;
     /**
-     * Source control provider settings for the pipeline. See Provider Settings Configuration below for details.
+     * The GraphQL ID of the pipeline template applied to this pipeline.
+     */
+    pipelineTemplateId?: pulumi.Input<string>;
+    /**
+     * Control settings depending on the VCS provider used in `repository`.
      */
     providerSettings?: pulumi.Input<inputs.Pipeline.PipelineProviderSettings>;
     /**
-     * The git URL of the repository.
+     * URL to the repository this pipeline is configured for.
      */
     repository?: pulumi.Input<string>;
     /**
-     * A boolean to enable automatically skipping any unstarted builds on the same branch when a new build is created.
+     * Whether to skip queued builds if a new commit is pushed to a matching branch.
      */
     skipIntermediateBuilds?: pulumi.Input<boolean>;
     /**
-     * Limit which branches build skipping applies to, for example `!master` will ensure that the master branch won't have its builds automatically skipped.
+     * Filter the `skip_intermediate_builds` setting based on this branch condition.
      */
     skipIntermediateBuildsBranchFilter?: pulumi.Input<string>;
     /**
-     * The buildkite slug of the team.
+     * The slug generated for the pipeline.
      */
     slug?: pulumi.Input<string>;
     /**
-     * The string YAML steps to run the pipeline. Defaults to `buildkite-agent pipeline upload` if not specified.
+     * The YAML steps to configure for the pipeline. Defaults to `buildkite-agent pipeline upload`.
      */
     steps?: pulumi.Input<string>;
+    /**
+     * Tags to attribute to the pipeline. Useful for searching by in the UI.
+     */
     tags?: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * Set team access for the pipeline. Can be specified multiple times for each team. See Teams Configuration below for details.
+     * The UUID of the pipeline.
      */
-    teams?: pulumi.Input<pulumi.Input<inputs.Pipeline.PipelineTeam>[]>;
+    uuid?: pulumi.Input<string>;
     /**
-     * The Buildkite webhook URL to configure on the repository to trigger builds on this pipeline.
+     * The webhook URL used to trigger builds from VCS providers.
      */
     webhookUrl?: pulumi.Input<string>;
 }
@@ -317,73 +243,83 @@ export interface PipelineState {
  */
 export interface PipelineArgs {
     /**
-     * A boolean on whether or not to allow rebuilds for the pipeline.
+     * Whether rebuilds are allowed for this pipeline.
      */
     allowRebuilds?: pulumi.Input<boolean>;
-    archiveOnDelete?: pulumi.Input<boolean>;
     /**
-     * Limit which branches and tags cause new builds to be created, either via a code push or via the Builds REST API.
+     * Configure the pipeline to only build on this branch conditional.
      */
     branchConfiguration?: pulumi.Input<string>;
     /**
-     * A boolean to enable automatically cancelling any running builds on the same branch when a new build is created.
+     * Whether to cancel builds when a new commit is pushed to a matching branch.
      */
     cancelIntermediateBuilds?: pulumi.Input<boolean>;
     /**
-     * Limit which branches build cancelling applies to, for example !master will ensure that the master branch won't have its builds automatically cancelled.
+     * Filter the `cancel_intermediate_builds` setting based on this branch condition.
      */
     cancelIntermediateBuildsBranchFilter?: pulumi.Input<string>;
     /**
-     * The GraphQL ID of the cluster you want to use for the pipeline.
+     * Attach this pipeline to the given cluster GraphQL ID.
      */
     clusterId?: pulumi.Input<string>;
     /**
-     * The default branch to prefill when new builds are created or triggered, usually main or master but can be anything.
+     * A color hex code to represent this pipeline.
+     */
+    color?: pulumi.Input<string>;
+    /**
+     * Default branch of the pipeline.
      */
     defaultBranch?: pulumi.Input<string>;
     /**
-     * The default timeout for commands in this pipeline, in minutes.
+     * The GraphQL ID of the team to use as the default owner of the pipeline.
      */
-    defaultTimeoutInMinutes?: pulumi.Input<number>;
+    defaultTeamId?: pulumi.Input<string>;
     /**
-     * Set to either `true` or `false`. When set to `true`, `destroy` actions on a pipeline will be blocked and fail with a message "Deletion protection is enabled for pipeline: <pipeline name>"
+     * Set pipeline wide timeout for command steps.
      */
-    deletionProtection?: pulumi.Input<boolean>;
+    defaultTimeoutInMinutes?: pulumi.Input<number>;
     /**
-     * A description of the pipeline.
+     * Description for the pipeline. Can include emoji 🙌.
      */
     description?: pulumi.Input<string>;
     /**
-     * The maximum timeout for commands in this pipeline, in minutes.
+     * An emoji that represents this pipeline.
+     */
+    emoji?: pulumi.Input<string>;
+    /**
+     * Set pipeline wide maximum timeout for command steps.
      */
     maximumTimeoutInMinutes?: pulumi.Input<number>;
     /**
-     * The name of the pipeline.
+     * Name to give the pipeline.
      */
     name?: pulumi.Input<string>;
     /**
-     * Source control provider settings for the pipeline. See Provider Settings Configuration below for details.
+     * The GraphQL ID of the pipeline template applied to this pipeline.
+     */
+    pipelineTemplateId?: pulumi.Input<string>;
+    /**
+     * Control settings depending on the VCS provider used in `repository`.
      */
     providerSettings?: pulumi.Input<inputs.Pipeline.PipelineProviderSettings>;
     /**
-     * The git URL of the repository.
+     * URL to the repository this pipeline is configured for.
      */
     repository: pulumi.Input<string>;
     /**
-     * A boolean to enable automatically skipping any unstarted builds on the same branch when a new build is created.
+     * Whether to skip queued builds if a new commit is pushed to a matching branch.
      */
     skipIntermediateBuilds?: pulumi.Input<boolean>;
     /**
-     * Limit which branches build skipping applies to, for example `!master` will ensure that the master branch won't have its builds automatically skipped.
+     * Filter the `skip_intermediate_builds` setting based on this branch condition.
      */
     skipIntermediateBuildsBranchFilter?: pulumi.Input<string>;
     /**
-     * The string YAML steps to run the pipeline. Defaults to `buildkite-agent pipeline upload` if not specified.
+     * The YAML steps to configure for the pipeline. Defaults to `buildkite-agent pipeline upload`.
      */
     steps?: pulumi.Input<string>;
-    tags?: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * Set team access for the pipeline. Can be specified multiple times for each team. See Teams Configuration below for details.
+     * Tags to attribute to the pipeline. Useful for searching by in the UI.
      */
-    teams?: pulumi.Input<pulumi.Input<inputs.Pipeline.PipelineTeam>[]>;
+    tags?: pulumi.Input<pulumi.Input<string>[]>;
 }