Harness v0.0.5, Oct 31 22

harness.platform.GithubConnector

Resource for creating a Github connector.

Create GithubConnector Resource

new GithubConnector(name: string, args: GithubConnectorArgs, opts?: CustomResourceOptions);

@overload
def GithubConnector(resource_name: 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,
                    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)
@overload
def GithubConnector(resource_name: str,
                    args: GithubConnectorArgs,
                    opts: Optional[ResourceOptions] = 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.

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.

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:

ConnectionType string: Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
Credentials Lbrlabs.PulumiPackage.Harness.Platform.Inputs.GithubConnectorCredentialsArgs: Credentials to use for the connection.
Identifier string: Unique identifier of the resource.
Url string: Url of the Githubhub repository or account.
ApiAuthentication Lbrlabs.PulumiPackage.Harness.Platform.Inputs.GithubConnectorApiAuthenticationArgs: 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.
DelegateSelectors List<string>: Connect using only the delegates which have these tags.
Description string: Description of the resource.
Name string: Name of the resource.
OrgId string: Unique identifier of the Organization.
ProjectId string: Unique identifier of the Project.
Tags List<string>: Tags to associate with the resource. Tags should be in the form name:value.
ValidationRepo string: Repository to test the connection with. This is only used when connection_type is Account.

ConnectionType string: Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
Credentials GithubConnectorCredentialsArgs: Credentials to use for the connection.
Identifier string: Unique identifier of the resource.
Url string: Url of the Githubhub repository or account.
ApiAuthentication GithubConnectorApiAuthenticationArgs: 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.
DelegateSelectors []string: Connect using only the delegates which have these tags.
Description string: Description of the resource.
Name string: Name of the resource.
OrgId string: Unique identifier of the Organization.
ProjectId string: Unique identifier of the Project.
Tags []string: Tags to associate with the resource. Tags should be in the form name:value.
ValidationRepo string: Repository to test the connection with. This is only used when connection_type is Account.

connectionType String: Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
credentials GithubConnectorCredentialsArgs: Credentials to use for the connection.
identifier String: Unique identifier of the resource.
url String: Url of the Githubhub repository or account.
apiAuthentication GithubConnectorApiAuthenticationArgs: 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.
delegateSelectors List<String>: Connect using only the delegates which have these tags.
description String: Description of the resource.
name String: Name of the resource.
orgId String: Unique identifier of the Organization.
projectId String: Unique identifier of the Project.
tags List<String>: Tags to associate with the resource. Tags should be in the form name:value.
validationRepo String: Repository to test the connection with. This is only used when connection_type is Account.

connectionType string: Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
credentials GithubConnectorCredentialsArgs: Credentials to use for the connection.
identifier string: Unique identifier of the resource.
url string: Url of the Githubhub repository or account.
apiAuthentication GithubConnectorApiAuthenticationArgs: 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.
delegateSelectors string[]: Connect using only the delegates which have these tags.
description string: Description of the resource.
name string: Name of the resource.
orgId string: Unique identifier of the Organization.
projectId string: Unique identifier of the Project.
tags string[]: Tags to associate with the resource. Tags should be in the form name:value.
validationRepo string: Repository to test the connection with. This is only used when connection_type is Account.

connection_type str: Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
credentials GithubConnectorCredentialsArgs: Credentials to use for the connection.
identifier str: Unique identifier of the resource.
url str: Url of the Githubhub repository or account.
api_authentication GithubConnectorApiAuthenticationArgs: 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]: Connect using only the delegates which have these tags.
description str: Description 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.
tags Sequence[str]: Tags to associate with the resource. Tags should be in the form name:value.
validation_repo str: Repository to test the connection with. This is only used when connection_type is Account.

connectionType 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.
apiAuthentication 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.
delegateSelectors List<String>: Connect using only the delegates which have these tags.
description String: Description of the resource.
name String: Name of the resource.
orgId String: Unique identifier of the Organization.
projectId String: Unique identifier of the Project.
tags List<String>: Tags to associate with the resource. Tags should be in the form name:value.
validationRepo String: Repository to test the connection with. This is only used when connection_type is Account.

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,
        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.

The following state arguments are supported:

ApiAuthentication Lbrlabs.PulumiPackage.Harness.Platform.Inputs.GithubConnectorApiAuthenticationArgs: 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.
ConnectionType string: Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
Credentials Lbrlabs.PulumiPackage.Harness.Platform.Inputs.GithubConnectorCredentialsArgs: Credentials to use for the connection.
DelegateSelectors List<string>: Connect using only the delegates which have these tags.
Description string: Description of the resource.
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.
Tags List<string>: Tags to associate with the resource. Tags should be in the form name:value.
Url string: Url of the Githubhub repository or account.
ValidationRepo string: Repository to test the connection with. This is only used when connection_type is Account.

ApiAuthentication GithubConnectorApiAuthenticationArgs: 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.
ConnectionType string: Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
Credentials GithubConnectorCredentialsArgs: Credentials to use for the connection.
DelegateSelectors []string: Connect using only the delegates which have these tags.
Description string: Description of the resource.
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.
Tags []string: Tags to associate with the resource. Tags should be in the form name:value.
Url string: Url of the Githubhub repository or account.
ValidationRepo string: Repository to test the connection with. This is only used when connection_type is Account.

apiAuthentication GithubConnectorApiAuthenticationArgs: 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.
connectionType String: Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
credentials GithubConnectorCredentialsArgs: Credentials to use for the connection.
delegateSelectors List<String>: Connect using only the delegates which have these tags.
description String: Description of the resource.
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.
tags List<String>: Tags to associate with the resource. Tags should be in the form name:value.
url String: Url of the Githubhub repository or account.
validationRepo String: Repository to test the connection with. This is only used when connection_type is Account.

apiAuthentication GithubConnectorApiAuthenticationArgs: 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.
connectionType string: Whether the connection we're making is to a github repository or a github account. Valid values are Account, Repo.
credentials GithubConnectorCredentialsArgs: Credentials to use for the connection.
delegateSelectors string[]: Connect using only the delegates which have these tags.
description string: Description of the resource.
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.
tags string[]: Tags to associate with the resource. Tags should be in the form name:value.
url string: Url of the Githubhub repository or account.
validationRepo string: Repository to test the connection with. This is only used when connection_type is Account.

api_authentication GithubConnectorApiAuthenticationArgs: 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 GithubConnectorCredentialsArgs: Credentials to use for the connection.
delegate_selectors Sequence[str]: Connect using only the delegates which have these tags.
description str: Description of the resource.
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.
tags Sequence[str]: Tags to associate with the resource. Tags should be in the form name:value.
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 is Account.

apiAuthentication 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.
connectionType 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.
delegateSelectors List<String>: Connect using only the delegates which have these tags.
description String: Description of the resource.
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.
tags List<String>: Tags to associate with the resource. Tags should be in the form name:value.
url String: Url of the Githubhub repository or account.
validationRepo String: Repository to test the connection with. This is only used when connection_type is Account.

Supporting Types

GithubConnectorApiAuthentication

GithubApp Lbrlabs.PulumiPackage.Harness.Platform.Inputs.GithubConnectorApiAuthenticationGithubApp: Configuration for using the github app for interacting with the github api.
TokenRef string: Personal access token for interacting with the github api.

GithubApp GithubConnectorApiAuthenticationGithubApp: Configuration for using the github app for interacting with the github api.
TokenRef string: Personal access token for interacting with the github api.

githubApp GithubConnectorApiAuthenticationGithubApp: Configuration for using the github app for interacting with the github api.
tokenRef String: Personal access token for interacting with the github api.

githubApp GithubConnectorApiAuthenticationGithubApp: Configuration for using the github app for interacting with the github api.
tokenRef string: Personal access token for interacting with the github api.

github_app GithubConnectorApiAuthenticationGithubApp: Configuration for using the github app for interacting with the github api.
token_ref str: Personal access token for interacting with the github api.

githubApp Property Map: Configuration for using the github app for interacting with the github api.
tokenRef String: Personal access token for interacting with the github api.

GithubConnectorApiAuthenticationGithubApp

ApplicationId string
InstallationId string
PrivateKeyRef string

ApplicationId string
InstallationId string
PrivateKeyRef string

applicationId String
installationId String
privateKeyRef String

applicationId string
installationId string
privateKeyRef string

application_id str
installation_id str
private_key_ref str

applicationId String
installationId String
privateKeyRef String

GithubConnectorCredentials

Http Lbrlabs.PulumiPackage.Harness.Platform.Inputs.GithubConnectorCredentialsHttp: Authenticate using Username and password over http(s) for the connection.
Ssh Lbrlabs.PulumiPackage.Harness.Platform.Inputs.GithubConnectorCredentialsSsh: Authenticate using SSH for the connection.

Http GithubConnectorCredentialsHttp: Authenticate using Username and password over http(s) for the connection.
Ssh GithubConnectorCredentialsSsh: Authenticate using SSH for the connection.

http GithubConnectorCredentialsHttp: Authenticate using Username and password over http(s) for the connection.
ssh GithubConnectorCredentialsSsh: Authenticate using SSH for the connection.

http GithubConnectorCredentialsHttp: Authenticate using Username and password over http(s) for the connection.
ssh GithubConnectorCredentialsSsh: Authenticate using SSH for the connection.

http GithubConnectorCredentialsHttp: Authenticate using Username and password over http(s) for the connection.
ssh GithubConnectorCredentialsSsh: 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.