@pulumi/harness/platform/githubConnector.d.ts

A Pulumi package for creating and managing Harness resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Resource for creating a Github connector.
 *
 * ## Import
 *
 * The `pulumi import` command can be used, for example:
 *
 * Import account level github connector
 *
 * ```sh
 * $ pulumi import harness:platform/githubConnector:GithubConnector example <connector_id>
 * ```
 *
 * Import org level github connector
 *
 * ```sh
 * $ pulumi import harness:platform/githubConnector:GithubConnector example <ord_id>/<connector_id>
 * ```
 *
 * Import project level github connector
 *
 * ```sh
 * $ pulumi import harness:platform/githubConnector:GithubConnector example <org_id>/<project_id>/<connector_id>
 * ```
 */
export declare class GithubConnector extends pulumi.CustomResource {
    /**
     * Get an existing GithubConnector 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?: GithubConnectorState, opts?: pulumi.CustomResourceOptions): GithubConnector;
    /**
     * Returns true if the given object is an instance of GithubConnector.  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 GithubConnector;
    /**
     * Configuration for using the github api. API Access is required for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
     */
    readonly apiAuthentication: pulumi.Output<outputs.platform.GithubConnectorApiAuthentication | undefined>;
    /**
     * Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
     */
    readonly connectionType: pulumi.Output<string>;
    /**
     * Credentials to use for the connection.
     */
    readonly credentials: pulumi.Output<outputs.platform.GithubConnectorCredentials>;
    /**
     * Tags to filter delegates for connection.
     */
    readonly delegateSelectors: pulumi.Output<string[] | undefined>;
    /**
     * Description of the resource.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Execute on delegate or not.
     */
    readonly executeOnDelegate: pulumi.Output<boolean | undefined>;
    /**
     * Enable this flag for force deletion of service
     */
    readonly forceDelete: pulumi.Output<boolean>;
    /**
     * Unique identifier of the resource.
     */
    readonly identifier: pulumi.Output<string>;
    /**
     * Name of the resource.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Unique identifier of the organization.
     */
    readonly orgId: pulumi.Output<string | undefined>;
    /**
     * Unique identifier of the project.
     */
    readonly projectId: pulumi.Output<string | undefined>;
    /**
     * Tags to associate with the resource.
     */
    readonly tags: pulumi.Output<string[] | undefined>;
    /**
     * URL of the Github repository or account.
     */
    readonly url: pulumi.Output<string>;
    /**
     * Repository to test the connection with. This is only used when `connectionType` is `Account`.
     */
    readonly validationRepo: pulumi.Output<string | undefined>;
    /**
     * Create a GithubConnector 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: GithubConnectorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering GithubConnector resources.
 */
export interface GithubConnectorState {
    /**
     * Configuration for using the github api. API Access is required for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
     */
    apiAuthentication?: pulumi.Input<inputs.platform.GithubConnectorApiAuthentication>;
    /**
     * Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
     */
    connectionType?: pulumi.Input<string>;
    /**
     * Credentials to use for the connection.
     */
    credentials?: pulumi.Input<inputs.platform.GithubConnectorCredentials>;
    /**
     * Tags to filter delegates for connection.
     */
    delegateSelectors?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Description of the resource.
     */
    description?: pulumi.Input<string>;
    /**
     * Execute on delegate or not.
     */
    executeOnDelegate?: pulumi.Input<boolean>;
    /**
     * Enable this flag for force deletion of service
     */
    forceDelete?: pulumi.Input<boolean>;
    /**
     * Unique identifier of the resource.
     */
    identifier?: pulumi.Input<string>;
    /**
     * 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>[]>;
    /**
     * URL of the Github repository or account.
     */
    url?: pulumi.Input<string>;
    /**
     * Repository to test the connection with. This is only used when `connectionType` is `Account`.
     */
    validationRepo?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a GithubConnector resource.
 */
export interface GithubConnectorArgs {
    /**
     * Configuration for using the github api. API Access is required for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
     */
    apiAuthentication?: pulumi.Input<inputs.platform.GithubConnectorApiAuthentication>;
    /**
     * Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
     */
    connectionType: pulumi.Input<string>;
    /**
     * Credentials to use for the connection.
     */
    credentials: pulumi.Input<inputs.platform.GithubConnectorCredentials>;
    /**
     * Tags to filter delegates for connection.
     */
    delegateSelectors?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Description of the resource.
     */
    description?: pulumi.Input<string>;
    /**
     * Execute on delegate or not.
     */
    executeOnDelegate?: pulumi.Input<boolean>;
    /**
     * Enable this flag for force deletion of service
     */
    forceDelete?: pulumi.Input<boolean>;
    /**
     * Unique identifier of the resource.
     */
    identifier: pulumi.Input<string>;
    /**
     * 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>[]>;
    /**
     * URL of the Github repository or account.
     */
    url: pulumi.Input<string>;
    /**
     * Repository to test the connection with. This is only used when `connectionType` is `Account`.
     */
    validationRepo?: pulumi.Input<string>;
}