@lbrlabs/pulumi-harness
Version:
A Pulumi package for creating and managing Harness resources.
222 lines (221 loc) • 7.38 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Resource for creating a git connector
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as harness from "@lbrlabs/pulumi-harness";
* import * as harness from "@pulumi/harness";
*
* const default = harness.getSecretManager({
* "default": true,
* });
* const exampleEncryptedText = new harness.EncryptedText("exampleEncryptedText", {
* value: "foo",
* secretManagerId: _default.then(_default => _default.id),
* });
* const exampleGitConnector = new harness.GitConnector("exampleGitConnector", {
* url: "https://github.com/harness/terraform-provider-harness",
* branch: "master",
* generateWebhookUrl: true,
* passwordSecretId: exampleEncryptedText.id,
* urlType: "REPO",
* username: "someuser",
* });
* ```
*
* ## Import
*
* Import using the Harness git connector id
*
* ```sh
* $ pulumi import harness:index/gitConnector:GitConnector example <connector_id>
* ```
*/
export declare class GitConnector extends pulumi.CustomResource {
/**
* Get an existing GitConnector 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?: GitConnectorState, opts?: pulumi.CustomResourceOptions): GitConnector;
/**
* Returns true if the given object is an instance of GitConnector. 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 GitConnector;
/**
* The branch of the git connector to use
*/
readonly branch: pulumi.Output<string | undefined>;
/**
* Custom details to use when making commits using this git connector
*/
readonly commitDetails: pulumi.Output<outputs.GitConnectorCommitDetails | undefined>;
/**
* The time the git connector was created
*/
readonly createdAt: pulumi.Output<string>;
/**
* Delegate selectors to apply to this git connector.
*/
readonly delegateSelectors: pulumi.Output<string[] | undefined>;
/**
* Boolean indicating whether or not to generate a webhook url.
*/
readonly generateWebhookUrl: pulumi.Output<boolean | undefined>;
/**
* Name of the git connector.
*/
readonly name: pulumi.Output<string>;
/**
* The id of the secret for connecting to the git repository.
*/
readonly passwordSecretId: pulumi.Output<string | undefined>;
/**
* The id of the SSH secret to use
*/
readonly sshSettingId: pulumi.Output<string | undefined>;
/**
* The URL of the git repository or account/organization
*/
readonly url: pulumi.Output<string>;
/**
* The type of git url being used. Options are `ACCOUNT`, and `REPO.`
*/
readonly urlType: pulumi.Output<string>;
/**
* This block is used for scoping the resource to a specific set of applications or environments.
*/
readonly usageScopes: pulumi.Output<outputs.GitConnectorUsageScope[] | undefined>;
/**
* The name of the user used to connect to the git repository
*/
readonly username: pulumi.Output<string | undefined>;
/**
* The generated webhook url
*/
readonly webhookUrl: pulumi.Output<string>;
/**
* Create a GitConnector 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: GitConnectorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering GitConnector resources.
*/
export interface GitConnectorState {
/**
* The branch of the git connector to use
*/
branch?: pulumi.Input<string>;
/**
* Custom details to use when making commits using this git connector
*/
commitDetails?: pulumi.Input<inputs.GitConnectorCommitDetails>;
/**
* The time the git connector was created
*/
createdAt?: pulumi.Input<string>;
/**
* Delegate selectors to apply to this git connector.
*/
delegateSelectors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Boolean indicating whether or not to generate a webhook url.
*/
generateWebhookUrl?: pulumi.Input<boolean>;
/**
* Name of the git connector.
*/
name?: pulumi.Input<string>;
/**
* The id of the secret for connecting to the git repository.
*/
passwordSecretId?: pulumi.Input<string>;
/**
* The id of the SSH secret to use
*/
sshSettingId?: pulumi.Input<string>;
/**
* The URL of the git repository or account/organization
*/
url?: pulumi.Input<string>;
/**
* The type of git url being used. Options are `ACCOUNT`, and `REPO.`
*/
urlType?: pulumi.Input<string>;
/**
* This block is used for scoping the resource to a specific set of applications or environments.
*/
usageScopes?: pulumi.Input<pulumi.Input<inputs.GitConnectorUsageScope>[]>;
/**
* The name of the user used to connect to the git repository
*/
username?: pulumi.Input<string>;
/**
* The generated webhook url
*/
webhookUrl?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a GitConnector resource.
*/
export interface GitConnectorArgs {
/**
* The branch of the git connector to use
*/
branch?: pulumi.Input<string>;
/**
* Custom details to use when making commits using this git connector
*/
commitDetails?: pulumi.Input<inputs.GitConnectorCommitDetails>;
/**
* Delegate selectors to apply to this git connector.
*/
delegateSelectors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Boolean indicating whether or not to generate a webhook url.
*/
generateWebhookUrl?: pulumi.Input<boolean>;
/**
* Name of the git connector.
*/
name?: pulumi.Input<string>;
/**
* The id of the secret for connecting to the git repository.
*/
passwordSecretId?: pulumi.Input<string>;
/**
* The id of the SSH secret to use
*/
sshSettingId?: pulumi.Input<string>;
/**
* The URL of the git repository or account/organization
*/
url: pulumi.Input<string>;
/**
* The type of git url being used. Options are `ACCOUNT`, and `REPO.`
*/
urlType: pulumi.Input<string>;
/**
* This block is used for scoping the resource to a specific set of applications or environments.
*/
usageScopes?: pulumi.Input<pulumi.Input<inputs.GitConnectorUsageScope>[]>;
/**
* The name of the user used to connect to the git repository
*/
username?: pulumi.Input<string>;
}