@pulumi/harness
Version:
A Pulumi package for creating and managing Harness resources.
216 lines (215 loc) • 6.92 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Resource for creating triggers in Harness.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as harness from "@pulumi/harness";
*
* const example = new harness.platform.Triggers("example", {
* identifier: "identifier",
* orgId: "orgIdentifer",
* projectId: "projectIdentifier",
* name: "name",
* targetId: "pipelineIdentifier",
* yaml: `trigger:
* name: name
* identifier: identifier
* enabled: true
* description: ""
* tags: {}
* projectIdentifier: projectIdentifier
* orgIdentifier: orgIdentifer
* pipelineIdentifier: pipelineIdentifier
* source:
* type: Webhook
* spec:
* type: Github
* spec:
* type: Push
* spec:
* connectorRef: account.TestAccResourceConnectorGithub_Ssh_IZBeG
* autoAbortPreviousExecutions: false
* payloadConditions:
* - key: changedFiles
* operator: Equals
* value: value
* - key: targetBranch
* operator: Equals
* value: value
* headerConditions: []
* repoName: repoName
* actions: []
* inputYaml: |
* pipeline: {}\\n
* `,
* });
* ```
*
* ## Import
*
* The `pulumi import` command can be used, for example:
*
* Import trigger
*
* ```sh
* $ pulumi import harness:platform/triggers:Triggers example <org_id>/<project_id>/<target_id>/<triggers_id>
* ```
*/
export declare class Triggers extends pulumi.CustomResource {
/**
* Get an existing Triggers resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TriggersState, opts?: pulumi.CustomResourceOptions): Triggers;
/**
* Returns true if the given object is an instance of Triggers. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Triggers;
/**
* Description of the resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Unique identifier of the resource.
*/
readonly identifier: pulumi.Output<string>;
/**
* if-Match
*/
readonly ifMatch: pulumi.Output<string | undefined>;
/**
* ignore error default false
*/
readonly ignoreError: pulumi.Output<boolean | undefined>;
/**
* Name of the resource.
*/
readonly name: pulumi.Output<string>;
/**
* Unique identifier of the organization.
*/
readonly orgId: pulumi.Output<string>;
/**
* Unique identifier of the project.
*/
readonly projectId: pulumi.Output<string>;
/**
* Tags to associate with the resource.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* Identifier of the target pipeline
*/
readonly targetId: pulumi.Output<string>;
/**
* trigger yaml. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
*/
readonly yaml: pulumi.Output<string>;
/**
* Create a Triggers resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: TriggersArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Triggers resources.
*/
export interface TriggersState {
/**
* Description of the resource.
*/
description?: pulumi.Input<string>;
/**
* Unique identifier of the resource.
*/
identifier?: pulumi.Input<string>;
/**
* if-Match
*/
ifMatch?: pulumi.Input<string>;
/**
* ignore error default false
*/
ignoreError?: pulumi.Input<boolean>;
/**
* Name of the resource.
*/
name?: pulumi.Input<string>;
/**
* Unique identifier of the organization.
*/
orgId?: pulumi.Input<string>;
/**
* Unique identifier of the project.
*/
projectId?: pulumi.Input<string>;
/**
* Tags to associate with the resource.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Identifier of the target pipeline
*/
targetId?: pulumi.Input<string>;
/**
* trigger yaml. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
*/
yaml?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Triggers resource.
*/
export interface TriggersArgs {
/**
* Description of the resource.
*/
description?: pulumi.Input<string>;
/**
* Unique identifier of the resource.
*/
identifier: pulumi.Input<string>;
/**
* if-Match
*/
ifMatch?: pulumi.Input<string>;
/**
* ignore error default false
*/
ignoreError?: pulumi.Input<boolean>;
/**
* Name of the resource.
*/
name?: pulumi.Input<string>;
/**
* Unique identifier of the organization.
*/
orgId: pulumi.Input<string>;
/**
* Unique identifier of the project.
*/
projectId: pulumi.Input<string>;
/**
* Tags to associate with the resource.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Identifier of the target pipeline
*/
targetId: pulumi.Input<string>;
/**
* trigger yaml. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
*/
yaml: pulumi.Input<string>;
}