harness.platform.GithubConnector
Explore with Pulumi AI
Resource for creating a Github connector.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Harness = Lbrlabs.PulumiPackage.Harness;
return await Deployment.RunAsync(() =>
{
var test = new Harness.Platform.GithubConnector("test", new()
{
ApiAuthentication = new Harness.Platform.Inputs.GithubConnectorApiAuthenticationArgs
{
GithubApp = new Harness.Platform.Inputs.GithubConnectorApiAuthenticationGithubAppArgs
{
ApplicationId = "application_id",
InstallationId = "installation_id",
PrivateKeyRef = "account.secret_id",
},
},
ConnectionType = "Account",
Credentials = new Harness.Platform.Inputs.GithubConnectorCredentialsArgs
{
Http = new Harness.Platform.Inputs.GithubConnectorCredentialsHttpArgs
{
TokenRef = "account.secret_id",
Username = "username",
},
},
DelegateSelectors = new[]
{
"harness-delegate",
},
Description = "test",
Identifier = "identifier",
Tags = new[]
{
"foo:bar",
},
Url = "https://github.com/account",
ValidationRepo = "some_repo",
});
});
package main
import (
"github.com/lbrlabs/pulumi-harness/sdk/go/harness/platform"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := platform.NewGithubConnector(ctx, "test", &platform.GithubConnectorArgs{
ApiAuthentication: &platform.GithubConnectorApiAuthenticationArgs{
GithubApp: &platform.GithubConnectorApiAuthenticationGithubAppArgs{
ApplicationId: pulumi.String("application_id"),
InstallationId: pulumi.String("installation_id"),
PrivateKeyRef: pulumi.String("account.secret_id"),
},
},
ConnectionType: pulumi.String("Account"),
Credentials: &platform.GithubConnectorCredentialsArgs{
Http: &platform.GithubConnectorCredentialsHttpArgs{
TokenRef: pulumi.String("account.secret_id"),
Username: pulumi.String("username"),
},
},
DelegateSelectors: pulumi.StringArray{
pulumi.String("harness-delegate"),
},
Description: pulumi.String("test"),
Identifier: pulumi.String("identifier"),
Tags: pulumi.StringArray{
pulumi.String("foo:bar"),
},
Url: pulumi.String("https://github.com/account"),
ValidationRepo: pulumi.String("some_repo"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.platform.GithubConnector;
import com.pulumi.harness.platform.GithubConnectorArgs;
import com.pulumi.harness.platform.inputs.GithubConnectorApiAuthenticationArgs;
import com.pulumi.harness.platform.inputs.GithubConnectorApiAuthenticationGithubAppArgs;
import com.pulumi.harness.platform.inputs.GithubConnectorCredentialsArgs;
import com.pulumi.harness.platform.inputs.GithubConnectorCredentialsHttpArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var test = new GithubConnector("test", GithubConnectorArgs.builder()
.apiAuthentication(GithubConnectorApiAuthenticationArgs.builder()
.githubApp(GithubConnectorApiAuthenticationGithubAppArgs.builder()
.applicationId("application_id")
.installationId("installation_id")
.privateKeyRef("account.secret_id")
.build())
.build())
.connectionType("Account")
.credentials(GithubConnectorCredentialsArgs.builder()
.http(GithubConnectorCredentialsHttpArgs.builder()
.tokenRef("account.secret_id")
.username("username")
.build())
.build())
.delegateSelectors("harness-delegate")
.description("test")
.identifier("identifier")
.tags("foo:bar")
.url("https://github.com/account")
.validationRepo("some_repo")
.build());
}
}
import pulumi
import lbrlabs_pulumi_harness as harness
test = harness.platform.GithubConnector("test",
api_authentication=harness.platform.GithubConnectorApiAuthenticationArgs(
github_app=harness.platform.GithubConnectorApiAuthenticationGithubAppArgs(
application_id="application_id",
installation_id="installation_id",
private_key_ref="account.secret_id",
),
),
connection_type="Account",
credentials=harness.platform.GithubConnectorCredentialsArgs(
http=harness.platform.GithubConnectorCredentialsHttpArgs(
token_ref="account.secret_id",
username="username",
),
),
delegate_selectors=["harness-delegate"],
description="test",
identifier="identifier",
tags=["foo:bar"],
url="https://github.com/account",
validation_repo="some_repo")
import * as pulumi from "@pulumi/pulumi";
import * as harness from "@lbrlabs/pulumi-harness";
const test = new harness.platform.GithubConnector("test", {
apiAuthentication: {
githubApp: {
applicationId: "application_id",
installationId: "installation_id",
privateKeyRef: "account.secret_id",
},
},
connectionType: "Account",
credentials: {
http: {
tokenRef: "account.secret_id",
username: "username",
},
},
delegateSelectors: ["harness-delegate"],
description: "test",
identifier: "identifier",
tags: ["foo:bar"],
url: "https://github.com/account",
validationRepo: "some_repo",
});
resources:
test:
type: harness:platform:GithubConnector
properties:
apiAuthentication:
githubApp:
applicationId: application_id
installationId: installation_id
privateKeyRef: account.secret_id
connectionType: Account
credentials:
http:
tokenRef: account.secret_id
username: username
delegateSelectors:
- harness-delegate
description: test
identifier: identifier
tags:
- foo:bar
url: https://github.com/account
validationRepo: some_repo
Create GithubConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GithubConnector(name: string, args: GithubConnectorArgs, opts?: CustomResourceOptions);
@overload
def GithubConnector(resource_name: str,
args: GithubConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GithubConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
identifier: Optional[str] = None,
connection_type: Optional[str] = None,
credentials: Optional[GithubConnectorCredentialsArgs] = None,
url: Optional[str] = None,
delegate_selectors: Optional[Sequence[str]] = None,
execute_on_delegate: Optional[bool] = None,
description: Optional[str] = None,
name: Optional[str] = None,
org_id: Optional[str] = None,
project_id: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
api_authentication: Optional[GithubConnectorApiAuthenticationArgs] = None,
validation_repo: Optional[str] = None)
func NewGithubConnector(ctx *Context, name string, args GithubConnectorArgs, opts ...ResourceOption) (*GithubConnector, error)
public GithubConnector(string name, GithubConnectorArgs args, CustomResourceOptions? opts = null)
public GithubConnector(String name, GithubConnectorArgs args)
public GithubConnector(String name, GithubConnectorArgs args, CustomResourceOptions options)
type: harness:platform:GithubConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args GithubConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GithubConnectorArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GithubConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GithubConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GithubConnectorArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var githubConnectorResource = new Harness.Platform.GithubConnector("githubConnectorResource", new()
{
Identifier = "string",
ConnectionType = "string",
Credentials = new Harness.Platform.Inputs.GithubConnectorCredentialsArgs
{
Http = new Harness.Platform.Inputs.GithubConnectorCredentialsHttpArgs
{
TokenRef = "string",
Username = "string",
UsernameRef = "string",
},
Ssh = new Harness.Platform.Inputs.GithubConnectorCredentialsSshArgs
{
SshKeyRef = "string",
},
},
Url = "string",
DelegateSelectors = new[]
{
"string",
},
ExecuteOnDelegate = false,
Description = "string",
Name = "string",
OrgId = "string",
ProjectId = "string",
Tags = new[]
{
"string",
},
ApiAuthentication = new Harness.Platform.Inputs.GithubConnectorApiAuthenticationArgs
{
GithubApp = new Harness.Platform.Inputs.GithubConnectorApiAuthenticationGithubAppArgs
{
PrivateKeyRef = "string",
ApplicationId = "string",
ApplicationIdRef = "string",
InstallationId = "string",
InstallationIdRef = "string",
},
TokenRef = "string",
},
ValidationRepo = "string",
});
example, err := platform.NewGithubConnector(ctx, "githubConnectorResource", &platform.GithubConnectorArgs{
Identifier: pulumi.String("string"),
ConnectionType: pulumi.String("string"),
Credentials: &platform.GithubConnectorCredentialsArgs{
Http: &platform.GithubConnectorCredentialsHttpArgs{
TokenRef: pulumi.String("string"),
Username: pulumi.String("string"),
UsernameRef: pulumi.String("string"),
},
Ssh: &platform.GithubConnectorCredentialsSshArgs{
SshKeyRef: pulumi.String("string"),
},
},
Url: pulumi.String("string"),
DelegateSelectors: pulumi.StringArray{
pulumi.String("string"),
},
ExecuteOnDelegate: pulumi.Bool(false),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
OrgId: pulumi.String("string"),
ProjectId: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
ApiAuthentication: &platform.GithubConnectorApiAuthenticationArgs{
GithubApp: &platform.GithubConnectorApiAuthenticationGithubAppArgs{
PrivateKeyRef: pulumi.String("string"),
ApplicationId: pulumi.String("string"),
ApplicationIdRef: pulumi.String("string"),
InstallationId: pulumi.String("string"),
InstallationIdRef: pulumi.String("string"),
},
TokenRef: pulumi.String("string"),
},
ValidationRepo: pulumi.String("string"),
})
var githubConnectorResource = new GithubConnector("githubConnectorResource", GithubConnectorArgs.builder()
.identifier("string")
.connectionType("string")
.credentials(GithubConnectorCredentialsArgs.builder()
.http(GithubConnectorCredentialsHttpArgs.builder()
.tokenRef("string")
.username("string")
.usernameRef("string")
.build())
.ssh(GithubConnectorCredentialsSshArgs.builder()
.sshKeyRef("string")
.build())
.build())
.url("string")
.delegateSelectors("string")
.executeOnDelegate(false)
.description("string")
.name("string")
.orgId("string")
.projectId("string")
.tags("string")
.apiAuthentication(GithubConnectorApiAuthenticationArgs.builder()
.githubApp(GithubConnectorApiAuthenticationGithubAppArgs.builder()
.privateKeyRef("string")
.applicationId("string")
.applicationIdRef("string")
.installationId("string")
.installationIdRef("string")
.build())
.tokenRef("string")
.build())
.validationRepo("string")
.build());
github_connector_resource = harness.platform.GithubConnector("githubConnectorResource",
identifier="string",
connection_type="string",
credentials=harness.platform.GithubConnectorCredentialsArgs(
http=harness.platform.GithubConnectorCredentialsHttpArgs(
token_ref="string",
username="string",
username_ref="string",
),
ssh=harness.platform.GithubConnectorCredentialsSshArgs(
ssh_key_ref="string",
),
),
url="string",
delegate_selectors=["string"],
execute_on_delegate=False,
description="string",
name="string",
org_id="string",
project_id="string",
tags=["string"],
api_authentication=harness.platform.GithubConnectorApiAuthenticationArgs(
github_app=harness.platform.GithubConnectorApiAuthenticationGithubAppArgs(
private_key_ref="string",
application_id="string",
application_id_ref="string",
installation_id="string",
installation_id_ref="string",
),
token_ref="string",
),
validation_repo="string")
const githubConnectorResource = new harness.platform.GithubConnector("githubConnectorResource", {
identifier: "string",
connectionType: "string",
credentials: {
http: {
tokenRef: "string",
username: "string",
usernameRef: "string",
},
ssh: {
sshKeyRef: "string",
},
},
url: "string",
delegateSelectors: ["string"],
executeOnDelegate: false,
description: "string",
name: "string",
orgId: "string",
projectId: "string",
tags: ["string"],
apiAuthentication: {
githubApp: {
privateKeyRef: "string",
applicationId: "string",
applicationIdRef: "string",
installationId: "string",
installationIdRef: "string",
},
tokenRef: "string",
},
validationRepo: "string",
});
type: harness:platform:GithubConnector
properties:
apiAuthentication:
githubApp:
applicationId: string
applicationIdRef: string
installationId: string
installationIdRef: string
privateKeyRef: string
tokenRef: string
connectionType: string
credentials:
http:
tokenRef: string
username: string
usernameRef: string
ssh:
sshKeyRef: string
delegateSelectors:
- string
description: string
executeOnDelegate: false
identifier: string
name: string
orgId: string
projectId: string
tags:
- string
url: string
validationRepo: string
GithubConnector Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The GithubConnector resource accepts the following input properties:
- Connection
Type string - Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
- Credentials
Lbrlabs.
Pulumi Package. Harness. Platform. Inputs. Github Connector Credentials - Credentials to use for the connection.
- Identifier string
- Unique identifier of the resource.
- Url string
- URL of the Githubhub repository or account.
- Api
Authentication Lbrlabs.Pulumi Package. Harness. Platform. Inputs. Github Connector Api Authentication - 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.
- Delegate
Selectors List<string> - Tags to filter delegates for connection.
- Description string
- Description of the resource.
- Execute
On boolDelegate - Execute on delegate or not.
- Name string
- Name of the resource.
- Org
Id string - Unique identifier of the organization.
- Project
Id string - Unique identifier of the project.
- List<string>
- Tags to associate with the resource.
- Validation
Repo string - Repository to test the connection with. This is only used when
connection_type
isAccount
.
- Connection
Type string - Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
- Credentials
Github
Connector Credentials Args - Credentials to use for the connection.
- Identifier string
- Unique identifier of the resource.
- Url string
- URL of the Githubhub repository or account.
- Api
Authentication GithubConnector Api Authentication Args - 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.
- Delegate
Selectors []string - Tags to filter delegates for connection.
- Description string
- Description of the resource.
- Execute
On boolDelegate - Execute on delegate or not.
- Name string
- Name of the resource.
- Org
Id string - Unique identifier of the organization.
- Project
Id string - Unique identifier of the project.
- []string
- Tags to associate with the resource.
- Validation
Repo string - Repository to test the connection with. This is only used when
connection_type
isAccount
.
- connection
Type String - Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
- credentials
Github
Connector Credentials - Credentials to use for the connection.
- identifier String
- Unique identifier of the resource.
- url String
- URL of the Githubhub repository or account.
- api
Authentication GithubConnector Api Authentication - 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.
- delegate
Selectors List<String> - Tags to filter delegates for connection.
- description String
- Description of the resource.
- execute
On BooleanDelegate - Execute on delegate or not.
- name String
- Name of the resource.
- org
Id String - Unique identifier of the organization.
- project
Id String - Unique identifier of the project.
- List<String>
- Tags to associate with the resource.
- validation
Repo String - Repository to test the connection with. This is only used when
connection_type
isAccount
.
- connection
Type string - Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
- credentials
Github
Connector Credentials - Credentials to use for the connection.
- identifier string
- Unique identifier of the resource.
- url string
- URL of the Githubhub repository or account.
- api
Authentication GithubConnector Api Authentication - 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.
- delegate
Selectors string[] - Tags to filter delegates for connection.
- description string
- Description of the resource.
- execute
On booleanDelegate - Execute on delegate or not.
- name string
- Name of the resource.
- org
Id string - Unique identifier of the organization.
- project
Id string - Unique identifier of the project.
- string[]
- Tags to associate with the resource.
- validation
Repo string - Repository to test the connection with. This is only used when
connection_type
isAccount
.
- connection_
type str - Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
- credentials
Github
Connector Credentials Args - Credentials to use for the connection.
- identifier str
- Unique identifier of the resource.
- url str
- URL of the Githubhub repository or account.
- api_
authentication GithubConnector Api Authentication Args - 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.
- delegate_
selectors Sequence[str] - Tags to filter delegates for connection.
- description str
- Description of the resource.
- execute_
on_ booldelegate - Execute on delegate or not.
- name str
- Name of the resource.
- org_
id str - Unique identifier of the organization.
- project_
id str - Unique identifier of the project.
- Sequence[str]
- Tags to associate with the resource.
- validation_
repo str - Repository to test the connection with. This is only used when
connection_type
isAccount
.
- connection
Type String - Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
- credentials Property Map
- Credentials to use for the connection.
- identifier String
- Unique identifier of the resource.
- url String
- URL of the Githubhub repository or account.
- api
Authentication Property Map - 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.
- delegate
Selectors List<String> - Tags to filter delegates for connection.
- description String
- Description of the resource.
- execute
On BooleanDelegate - Execute on delegate or not.
- name String
- Name of the resource.
- org
Id String - Unique identifier of the organization.
- project
Id String - Unique identifier of the project.
- List<String>
- Tags to associate with the resource.
- validation
Repo String - Repository to test the connection with. This is only used when
connection_type
isAccount
.
Outputs
All input properties are implicitly available as output properties. Additionally, the GithubConnector resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing GithubConnector Resource
Get an existing GithubConnector resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: GithubConnectorState, opts?: CustomResourceOptions): GithubConnector
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_authentication: Optional[GithubConnectorApiAuthenticationArgs] = None,
connection_type: Optional[str] = None,
credentials: Optional[GithubConnectorCredentialsArgs] = None,
delegate_selectors: Optional[Sequence[str]] = None,
description: Optional[str] = None,
execute_on_delegate: Optional[bool] = None,
identifier: Optional[str] = None,
name: Optional[str] = None,
org_id: Optional[str] = None,
project_id: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
url: Optional[str] = None,
validation_repo: Optional[str] = None) -> GithubConnector
func GetGithubConnector(ctx *Context, name string, id IDInput, state *GithubConnectorState, opts ...ResourceOption) (*GithubConnector, error)
public static GithubConnector Get(string name, Input<string> id, GithubConnectorState? state, CustomResourceOptions? opts = null)
public static GithubConnector get(String name, Output<String> id, GithubConnectorState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Api
Authentication Lbrlabs.Pulumi Package. Harness. Platform. Inputs. Github Connector Api Authentication - 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.
- Connection
Type string - Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
- Credentials
Lbrlabs.
Pulumi Package. Harness. Platform. Inputs. Github Connector Credentials - Credentials to use for the connection.
- Delegate
Selectors List<string> - Tags to filter delegates for connection.
- Description string
- Description of the resource.
- Execute
On boolDelegate - Execute on delegate or not.
- Identifier string
- Unique identifier of the resource.
- Name string
- Name of the resource.
- Org
Id string - Unique identifier of the organization.
- Project
Id string - Unique identifier of the project.
- List<string>
- Tags to associate with the resource.
- Url string
- URL of the Githubhub repository or account.
- Validation
Repo string - Repository to test the connection with. This is only used when
connection_type
isAccount
.
- Api
Authentication GithubConnector Api Authentication Args - 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.
- Connection
Type string - Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
- Credentials
Github
Connector Credentials Args - Credentials to use for the connection.
- Delegate
Selectors []string - Tags to filter delegates for connection.
- Description string
- Description of the resource.
- Execute
On boolDelegate - Execute on delegate or not.
- Identifier string
- Unique identifier of the resource.
- Name string
- Name of the resource.
- Org
Id string - Unique identifier of the organization.
- Project
Id string - Unique identifier of the project.
- []string
- Tags to associate with the resource.
- Url string
- URL of the Githubhub repository or account.
- Validation
Repo string - Repository to test the connection with. This is only used when
connection_type
isAccount
.
- api
Authentication GithubConnector Api Authentication - 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.
- connection
Type String - Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
- credentials
Github
Connector Credentials - Credentials to use for the connection.
- delegate
Selectors List<String> - Tags to filter delegates for connection.
- description String
- Description of the resource.
- execute
On BooleanDelegate - Execute on delegate or not.
- identifier String
- Unique identifier of the resource.
- name String
- Name of the resource.
- org
Id String - Unique identifier of the organization.
- project
Id String - Unique identifier of the project.
- List<String>
- Tags to associate with the resource.
- url String
- URL of the Githubhub repository or account.
- validation
Repo String - Repository to test the connection with. This is only used when
connection_type
isAccount
.
- api
Authentication GithubConnector Api Authentication - 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.
- connection
Type string - Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
- credentials
Github
Connector Credentials - Credentials to use for the connection.
- delegate
Selectors string[] - Tags to filter delegates for connection.
- description string
- Description of the resource.
- execute
On booleanDelegate - Execute on delegate or not.
- identifier string
- Unique identifier of the resource.
- name string
- Name of the resource.
- org
Id string - Unique identifier of the organization.
- project
Id string - Unique identifier of the project.
- string[]
- Tags to associate with the resource.
- url string
- URL of the Githubhub repository or account.
- validation
Repo string - Repository to test the connection with. This is only used when
connection_type
isAccount
.
- api_
authentication GithubConnector Api Authentication Args - 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.
- connection_
type str - Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
- credentials
Github
Connector Credentials Args - Credentials to use for the connection.
- delegate_
selectors Sequence[str] - Tags to filter delegates for connection.
- description str
- Description of the resource.
- execute_
on_ booldelegate - Execute on delegate or not.
- identifier str
- Unique identifier of the resource.
- name str
- Name of the resource.
- org_
id str - Unique identifier of the organization.
- project_
id str - Unique identifier of the project.
- Sequence[str]
- Tags to associate with the resource.
- url str
- URL of the Githubhub repository or account.
- validation_
repo str - Repository to test the connection with. This is only used when
connection_type
isAccount
.
- api
Authentication Property Map - 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.
- connection
Type String - Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
- credentials Property Map
- Credentials to use for the connection.
- delegate
Selectors List<String> - Tags to filter delegates for connection.
- description String
- Description of the resource.
- execute
On BooleanDelegate - Execute on delegate or not.
- identifier String
- Unique identifier of the resource.
- name String
- Name of the resource.
- org
Id String - Unique identifier of the organization.
- project
Id String - Unique identifier of the project.
- List<String>
- Tags to associate with the resource.
- url String
- URL of the Githubhub repository or account.
- validation
Repo String - Repository to test the connection with. This is only used when
connection_type
isAccount
.
Supporting Types
GithubConnectorApiAuthentication, GithubConnectorApiAuthenticationArgs
- Github
App Lbrlabs.Pulumi Package. Harness. Platform. Inputs. Github Connector Api Authentication Github App - Configuration for using the github app for interacting with the github api.
- Token
Ref string - Personal access token for interacting with the github api. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
- Github
App GithubConnector Api Authentication Github App - Configuration for using the github app for interacting with the github api.
- Token
Ref string - Personal access token for interacting with the github api. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
- github
App GithubConnector Api Authentication Github App - Configuration for using the github app for interacting with the github api.
- token
Ref String - Personal access token for interacting with the github api. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
- github
App GithubConnector Api Authentication Github App - Configuration for using the github app for interacting with the github api.
- token
Ref string - Personal access token for interacting with the github api. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
- github_
app GithubConnector Api Authentication Github App - Configuration for using the github app for interacting with the github api.
- token_
ref str - Personal access token for interacting with the github api. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
- github
App Property Map - Configuration for using the github app for interacting with the github api.
- token
Ref String - Personal access token for interacting with the github api. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
GithubConnectorApiAuthenticationGithubApp, GithubConnectorApiAuthenticationGithubAppArgs
- Private
Key stringRef - Application
Id string - Application
Id stringRef - Installation
Id string - Installation
Id stringRef
- Private
Key stringRef - Application
Id string - Application
Id stringRef - Installation
Id string - Installation
Id stringRef
- private
Key StringRef - application
Id String - application
Id StringRef - installation
Id String - installation
Id StringRef
- private
Key stringRef - application
Id string - application
Id stringRef - installation
Id string - installation
Id stringRef
- private
Key StringRef - application
Id String - application
Id StringRef - installation
Id String - installation
Id StringRef
GithubConnectorCredentials, GithubConnectorCredentialsArgs
- Http
Lbrlabs.
Pulumi Package. Harness. Platform. Inputs. Github Connector Credentials Http - Authenticate using Username and password over http(s) for the connection.
- Ssh
Lbrlabs.
Pulumi Package. Harness. Platform. Inputs. Github Connector Credentials Ssh - Authenticate using SSH for the connection.
- Http
Github
Connector Credentials Http - Authenticate using Username and password over http(s) for the connection.
- Ssh
Github
Connector Credentials Ssh - Authenticate using SSH for the connection.
- http
Github
Connector Credentials Http - Authenticate using Username and password over http(s) for the connection.
- ssh
Github
Connector Credentials Ssh - Authenticate using SSH for the connection.
- http
Github
Connector Credentials Http - Authenticate using Username and password over http(s) for the connection.
- ssh
Github
Connector Credentials Ssh - Authenticate using SSH for the connection.
- http
Github
Connector Credentials Http - Authenticate using Username and password over http(s) for the connection.
- ssh
Github
Connector Credentials Ssh - Authenticate using SSH for the connection.
- http Property Map
- Authenticate using Username and password over http(s) for the connection.
- ssh Property Map
- Authenticate using SSH for the connection.
GithubConnectorCredentialsHttp, GithubConnectorCredentialsHttpArgs
- Token
Ref string - Username string
- Username
Ref string
- Token
Ref string - Username string
- Username
Ref string
- token
Ref String - username String
- username
Ref String
- token
Ref string - username string
- username
Ref string
- token_
ref str - username str
- username_
ref str
- token
Ref String - username String
- username
Ref String
GithubConnectorCredentialsSsh, GithubConnectorCredentialsSshArgs
- Ssh
Key stringRef
- Ssh
Key stringRef
- ssh
Key StringRef
- ssh
Key stringRef
- ssh_
key_ strref
- ssh
Key StringRef
Import
Import account level github connector
$ pulumi import harness:platform/githubConnector:GithubConnector example <connector_id>
Import org level github connector
$ pulumi import harness:platform/githubConnector:GithubConnector example <ord_id>/<connector_id>
Import project level github connector
$ pulumi import harness:platform/githubConnector:GithubConnector example <org_id>/<project_id>/<connector_id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- harness lbrlabs/pulumi-harness
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
harness
Terraform Provider.