1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. getGithubConnector
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

harness.platform.getGithubConnector

Explore with Pulumi AI

harness logo
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

    Datasource for looking up a Github connector.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Pulumi.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Harness.Platform.GetGithubConnector.Invoke(new()
        {
            Identifier = "identifier",
        });
    
    });
    
    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.LookupGithubConnector(ctx, &platform.LookupGithubConnectorArgs{
    			Identifier: "identifier",
    		}, nil)
    		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.PlatformFunctions;
    import com.pulumi.harness.platform.inputs.GetGithubConnectorArgs;
    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) {
            final var example = PlatformFunctions.getGithubConnector(GetGithubConnectorArgs.builder()
                .identifier("identifier")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_harness as harness
    
    example = harness.platform.get_github_connector(identifier="identifier")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    const example = harness.platform.getGithubConnector({
        identifier: "identifier",
    });
    
    variables:
      example:
        fn::invoke:
          Function: harness:platform:getGithubConnector
          Arguments:
            identifier: identifier
    

    Using getGithubConnector

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGithubConnector(args: GetGithubConnectorArgs, opts?: InvokeOptions): Promise<GetGithubConnectorResult>
    function getGithubConnectorOutput(args: GetGithubConnectorOutputArgs, opts?: InvokeOptions): Output<GetGithubConnectorResult>
    def get_github_connector(identifier: Optional[str] = None,
                             name: Optional[str] = None,
                             org_id: Optional[str] = None,
                             project_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetGithubConnectorResult
    def get_github_connector_output(identifier: Optional[pulumi.Input[str]] = None,
                             name: Optional[pulumi.Input[str]] = None,
                             org_id: Optional[pulumi.Input[str]] = None,
                             project_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetGithubConnectorResult]
    func LookupGithubConnector(ctx *Context, args *LookupGithubConnectorArgs, opts ...InvokeOption) (*LookupGithubConnectorResult, error)
    func LookupGithubConnectorOutput(ctx *Context, args *LookupGithubConnectorOutputArgs, opts ...InvokeOption) LookupGithubConnectorResultOutput

    > Note: This function is named LookupGithubConnector in the Go SDK.

    public static class GetGithubConnector 
    {
        public static Task<GetGithubConnectorResult> InvokeAsync(GetGithubConnectorArgs args, InvokeOptions? opts = null)
        public static Output<GetGithubConnectorResult> Invoke(GetGithubConnectorInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGithubConnectorResult> getGithubConnector(GetGithubConnectorArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: harness:platform/getGithubConnector:getGithubConnector
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    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.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.

    getGithubConnector Result

    The following output properties are available:

    ApiAuthentications List<Lbrlabs.PulumiPackage.Harness.Platform.Outputs.GetGithubConnectorApiAuthentication>
    Configuration for using the github api. API Access is Computed for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
    ConnectionType string
    Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
    Credentials List<Lbrlabs.PulumiPackage.Harness.Platform.Outputs.GetGithubConnectorCredential>
    Credentials to use for the connection.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Unique identifier of the resource.
    Tags List<string>
    Tags to associate with the resource.
    Url string
    URL of the github repository or account.
    ValidationRepo string
    Repository to test the connection with. This is only used when connection_type is Account.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    ApiAuthentications []GetGithubConnectorApiAuthentication
    Configuration for using the github api. API Access is Computed for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
    ConnectionType string
    Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
    Credentials []GetGithubConnectorCredential
    Credentials to use for the connection.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Unique identifier of the resource.
    Tags []string
    Tags to associate with the resource.
    Url string
    URL of the github repository or account.
    ValidationRepo string
    Repository to test the connection with. This is only used when connection_type is Account.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    apiAuthentications List<GetGithubConnectorApiAuthentication>
    Configuration for using the github api. API Access is Computed for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
    connectionType String
    Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
    credentials List<GetGithubConnectorCredential>
    Credentials to use for the connection.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Unique identifier of the resource.
    tags List<String>
    Tags to associate with the resource.
    url String
    URL of the github repository or account.
    validationRepo String
    Repository to test the connection with. This is only used when connection_type is Account.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    apiAuthentications GetGithubConnectorApiAuthentication[]
    Configuration for using the github api. API Access is Computed for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
    connectionType string
    Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
    credentials GetGithubConnectorCredential[]
    Credentials to use for the connection.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    executeOnDelegate boolean
    id string
    The provider-assigned unique ID for this managed resource.
    identifier string
    Unique identifier of the resource.
    tags string[]
    Tags to associate with the resource.
    url string
    URL of the github repository or account.
    validationRepo string
    Repository to test the connection with. This is only used when connection_type is Account.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    api_authentications Sequence[GetGithubConnectorApiAuthentication]
    Configuration for using the github api. API Access is Computed 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 Sequence[GetGithubConnectorCredential]
    Credentials to use for the connection.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    execute_on_delegate bool
    id str
    The provider-assigned unique ID for this managed resource.
    identifier str
    Unique identifier of the resource.
    tags Sequence[str]
    Tags to associate with the resource.
    url str
    URL of the github repository or account.
    validation_repo str
    Repository to test the connection with. This is only used when connection_type is Account.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    apiAuthentications List<Property Map>
    Configuration for using the github api. API Access is Computed for using “Git Experience”, for creation of Git based triggers, Webhooks management and updating Git statuses.
    connectionType String
    Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
    credentials List<Property Map>
    Credentials to use for the connection.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Unique identifier of the resource.
    tags List<String>
    Tags to associate with the resource.
    url String
    URL of the github repository or account.
    validationRepo String
    Repository to test the connection with. This is only used when connection_type is Account.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.

    Supporting Types

    GetGithubConnectorApiAuthentication

    GetGithubConnectorApiAuthenticationGithubApp

    GetGithubConnectorCredential

    GetGithubConnectorCredentialHttp

    TokenRef string
    Username string
    UsernameRef string
    TokenRef string
    Username string
    UsernameRef string
    tokenRef String
    username String
    usernameRef String
    tokenRef string
    username string
    usernameRef string
    tokenRef String
    username String
    usernameRef String

    GetGithubConnectorCredentialSsh

    SshKeyRef string
    SshKeyRef string
    sshKeyRef String
    sshKeyRef string
    sshKeyRef String

    Package Details

    Repository
    harness lbrlabs/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs