ibm.CdToolchainToolGithubconsolidated
Explore with Pulumi AI
Create, update, and delete cd_toolchain_tool_githubconsolidateds with this resource.
See the tool integration page for more information.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const cdToolchainToolGithubconsolidatedInstance = new ibm.CdToolchainToolGithubconsolidated("cdToolchainToolGithubconsolidatedInstance", {
initialization: {
gitId: "github",
ownerId: "<github-user-id>",
repoName: "myrepo",
sourceRepoUrl: "https://github.com/source-repo-owner/source-repo",
type: "clone",
privateRepo: true,
},
parameters: {
integrationOwner: "my-userid",
authType: "pat",
apiToken: "<api_token>",
toolchainIssuesEnabled: true,
},
toolchainId: ibm_cd_toolchain.cd_toolchain.id,
});
import pulumi
import pulumi_ibm as ibm
cd_toolchain_tool_githubconsolidated_instance = ibm.CdToolchainToolGithubconsolidated("cdToolchainToolGithubconsolidatedInstance",
initialization={
"git_id": "github",
"owner_id": "<github-user-id>",
"repo_name": "myrepo",
"source_repo_url": "https://github.com/source-repo-owner/source-repo",
"type": "clone",
"private_repo": True,
},
parameters={
"integration_owner": "my-userid",
"auth_type": "pat",
"api_token": "<api_token>",
"toolchain_issues_enabled": True,
},
toolchain_id=ibm_cd_toolchain["cd_toolchain"]["id"])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ibm.NewCdToolchainToolGithubconsolidated(ctx, "cdToolchainToolGithubconsolidatedInstance", &ibm.CdToolchainToolGithubconsolidatedArgs{
Initialization: &ibm.CdToolchainToolGithubconsolidatedInitializationArgs{
GitId: pulumi.String("github"),
OwnerId: pulumi.String("<github-user-id>"),
RepoName: pulumi.String("myrepo"),
SourceRepoUrl: pulumi.String("https://github.com/source-repo-owner/source-repo"),
Type: pulumi.String("clone"),
PrivateRepo: pulumi.Bool(true),
},
Parameters: &ibm.CdToolchainToolGithubconsolidatedParametersArgs{
IntegrationOwner: pulumi.String("my-userid"),
AuthType: pulumi.String("pat"),
ApiToken: pulumi.String("<api_token>"),
ToolchainIssuesEnabled: pulumi.Bool(true),
},
ToolchainId: pulumi.Any(ibm_cd_toolchain.Cd_toolchain.Id),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var cdToolchainToolGithubconsolidatedInstance = new Ibm.CdToolchainToolGithubconsolidated("cdToolchainToolGithubconsolidatedInstance", new()
{
Initialization = new Ibm.Inputs.CdToolchainToolGithubconsolidatedInitializationArgs
{
GitId = "github",
OwnerId = "<github-user-id>",
RepoName = "myrepo",
SourceRepoUrl = "https://github.com/source-repo-owner/source-repo",
Type = "clone",
PrivateRepo = true,
},
Parameters = new Ibm.Inputs.CdToolchainToolGithubconsolidatedParametersArgs
{
IntegrationOwner = "my-userid",
AuthType = "pat",
ApiToken = "<api_token>",
ToolchainIssuesEnabled = true,
},
ToolchainId = ibm_cd_toolchain.Cd_toolchain.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.CdToolchainToolGithubconsolidated;
import com.pulumi.ibm.CdToolchainToolGithubconsolidatedArgs;
import com.pulumi.ibm.inputs.CdToolchainToolGithubconsolidatedInitializationArgs;
import com.pulumi.ibm.inputs.CdToolchainToolGithubconsolidatedParametersArgs;
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 cdToolchainToolGithubconsolidatedInstance = new CdToolchainToolGithubconsolidated("cdToolchainToolGithubconsolidatedInstance", CdToolchainToolGithubconsolidatedArgs.builder()
.initialization(CdToolchainToolGithubconsolidatedInitializationArgs.builder()
.gitId("github")
.ownerId("<github-user-id>")
.repoName("myrepo")
.sourceRepoUrl("https://github.com/source-repo-owner/source-repo")
.type("clone")
.privateRepo(true)
.build())
.parameters(CdToolchainToolGithubconsolidatedParametersArgs.builder()
.integrationOwner("my-userid")
.authType("pat")
.apiToken("<api_token>")
.toolchainIssuesEnabled(true)
.build())
.toolchainId(ibm_cd_toolchain.cd_toolchain().id())
.build());
}
}
resources:
cdToolchainToolGithubconsolidatedInstance:
type: ibm:CdToolchainToolGithubconsolidated
properties:
initialization:
gitId: github
ownerId: <github-user-id>
repoName: myrepo
sourceRepoUrl: https://github.com/source-repo-owner/source-repo
type: clone
privateRepo: true
parameters:
integrationOwner: my-userid
authType: pat
apiToken: <api_token>
toolchainIssuesEnabled: true
toolchainId: ${ibm_cd_toolchain.cd_toolchain.id}
Create CdToolchainToolGithubconsolidated Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CdToolchainToolGithubconsolidated(name: string, args: CdToolchainToolGithubconsolidatedArgs, opts?: CustomResourceOptions);
@overload
def CdToolchainToolGithubconsolidated(resource_name: str,
args: CdToolchainToolGithubconsolidatedArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CdToolchainToolGithubconsolidated(resource_name: str,
opts: Optional[ResourceOptions] = None,
initialization: Optional[CdToolchainToolGithubconsolidatedInitializationArgs] = None,
parameters: Optional[CdToolchainToolGithubconsolidatedParametersArgs] = None,
toolchain_id: Optional[str] = None,
cd_toolchain_tool_githubconsolidated_id: Optional[str] = None,
name: Optional[str] = None)
func NewCdToolchainToolGithubconsolidated(ctx *Context, name string, args CdToolchainToolGithubconsolidatedArgs, opts ...ResourceOption) (*CdToolchainToolGithubconsolidated, error)
public CdToolchainToolGithubconsolidated(string name, CdToolchainToolGithubconsolidatedArgs args, CustomResourceOptions? opts = null)
public CdToolchainToolGithubconsolidated(String name, CdToolchainToolGithubconsolidatedArgs args)
public CdToolchainToolGithubconsolidated(String name, CdToolchainToolGithubconsolidatedArgs args, CustomResourceOptions options)
type: ibm:CdToolchainToolGithubconsolidated
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 CdToolchainToolGithubconsolidatedArgs
- 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 CdToolchainToolGithubconsolidatedArgs
- 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 CdToolchainToolGithubconsolidatedArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CdToolchainToolGithubconsolidatedArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CdToolchainToolGithubconsolidatedArgs
- 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 cdToolchainToolGithubconsolidatedResource = new Ibm.CdToolchainToolGithubconsolidated("cdToolchainToolGithubconsolidatedResource", new()
{
Initialization = new Ibm.Inputs.CdToolchainToolGithubconsolidatedInitializationArgs
{
Type = "string",
AutoInit = false,
BlindConnection = false,
GitId = "string",
OwnerId = "string",
PrivateRepo = false,
RepoName = "string",
RepoUrl = "string",
RootUrl = "string",
SourceRepoUrl = "string",
Title = "string",
},
Parameters = new Ibm.Inputs.CdToolchainToolGithubconsolidatedParametersArgs
{
ApiRootUrl = "string",
ApiToken = "string",
AuthType = "string",
AutoInit = false,
BlindConnection = false,
DefaultBranch = "string",
EnableTraceability = false,
GitId = "string",
IntegrationOwner = "string",
OwnerId = "string",
PrivateRepo = false,
RepoId = "string",
RepoName = "string",
RepoUrl = "string",
RootUrl = "string",
SourceRepoUrl = "string",
Title = "string",
TokenUrl = "string",
ToolchainIssuesEnabled = false,
Type = "string",
},
ToolchainId = "string",
CdToolchainToolGithubconsolidatedId = "string",
Name = "string",
});
example, err := ibm.NewCdToolchainToolGithubconsolidated(ctx, "cdToolchainToolGithubconsolidatedResource", &ibm.CdToolchainToolGithubconsolidatedArgs{
Initialization: &ibm.CdToolchainToolGithubconsolidatedInitializationArgs{
Type: pulumi.String("string"),
AutoInit: pulumi.Bool(false),
BlindConnection: pulumi.Bool(false),
GitId: pulumi.String("string"),
OwnerId: pulumi.String("string"),
PrivateRepo: pulumi.Bool(false),
RepoName: pulumi.String("string"),
RepoUrl: pulumi.String("string"),
RootUrl: pulumi.String("string"),
SourceRepoUrl: pulumi.String("string"),
Title: pulumi.String("string"),
},
Parameters: &ibm.CdToolchainToolGithubconsolidatedParametersArgs{
ApiRootUrl: pulumi.String("string"),
ApiToken: pulumi.String("string"),
AuthType: pulumi.String("string"),
AutoInit: pulumi.Bool(false),
BlindConnection: pulumi.Bool(false),
DefaultBranch: pulumi.String("string"),
EnableTraceability: pulumi.Bool(false),
GitId: pulumi.String("string"),
IntegrationOwner: pulumi.String("string"),
OwnerId: pulumi.String("string"),
PrivateRepo: pulumi.Bool(false),
RepoId: pulumi.String("string"),
RepoName: pulumi.String("string"),
RepoUrl: pulumi.String("string"),
RootUrl: pulumi.String("string"),
SourceRepoUrl: pulumi.String("string"),
Title: pulumi.String("string"),
TokenUrl: pulumi.String("string"),
ToolchainIssuesEnabled: pulumi.Bool(false),
Type: pulumi.String("string"),
},
ToolchainId: pulumi.String("string"),
CdToolchainToolGithubconsolidatedId: pulumi.String("string"),
Name: pulumi.String("string"),
})
var cdToolchainToolGithubconsolidatedResource = new CdToolchainToolGithubconsolidated("cdToolchainToolGithubconsolidatedResource", CdToolchainToolGithubconsolidatedArgs.builder()
.initialization(CdToolchainToolGithubconsolidatedInitializationArgs.builder()
.type("string")
.autoInit(false)
.blindConnection(false)
.gitId("string")
.ownerId("string")
.privateRepo(false)
.repoName("string")
.repoUrl("string")
.rootUrl("string")
.sourceRepoUrl("string")
.title("string")
.build())
.parameters(CdToolchainToolGithubconsolidatedParametersArgs.builder()
.apiRootUrl("string")
.apiToken("string")
.authType("string")
.autoInit(false)
.blindConnection(false)
.defaultBranch("string")
.enableTraceability(false)
.gitId("string")
.integrationOwner("string")
.ownerId("string")
.privateRepo(false)
.repoId("string")
.repoName("string")
.repoUrl("string")
.rootUrl("string")
.sourceRepoUrl("string")
.title("string")
.tokenUrl("string")
.toolchainIssuesEnabled(false)
.type("string")
.build())
.toolchainId("string")
.cdToolchainToolGithubconsolidatedId("string")
.name("string")
.build());
cd_toolchain_tool_githubconsolidated_resource = ibm.CdToolchainToolGithubconsolidated("cdToolchainToolGithubconsolidatedResource",
initialization={
"type": "string",
"auto_init": False,
"blind_connection": False,
"git_id": "string",
"owner_id": "string",
"private_repo": False,
"repo_name": "string",
"repo_url": "string",
"root_url": "string",
"source_repo_url": "string",
"title": "string",
},
parameters={
"api_root_url": "string",
"api_token": "string",
"auth_type": "string",
"auto_init": False,
"blind_connection": False,
"default_branch": "string",
"enable_traceability": False,
"git_id": "string",
"integration_owner": "string",
"owner_id": "string",
"private_repo": False,
"repo_id": "string",
"repo_name": "string",
"repo_url": "string",
"root_url": "string",
"source_repo_url": "string",
"title": "string",
"token_url": "string",
"toolchain_issues_enabled": False,
"type": "string",
},
toolchain_id="string",
cd_toolchain_tool_githubconsolidated_id="string",
name="string")
const cdToolchainToolGithubconsolidatedResource = new ibm.CdToolchainToolGithubconsolidated("cdToolchainToolGithubconsolidatedResource", {
initialization: {
type: "string",
autoInit: false,
blindConnection: false,
gitId: "string",
ownerId: "string",
privateRepo: false,
repoName: "string",
repoUrl: "string",
rootUrl: "string",
sourceRepoUrl: "string",
title: "string",
},
parameters: {
apiRootUrl: "string",
apiToken: "string",
authType: "string",
autoInit: false,
blindConnection: false,
defaultBranch: "string",
enableTraceability: false,
gitId: "string",
integrationOwner: "string",
ownerId: "string",
privateRepo: false,
repoId: "string",
repoName: "string",
repoUrl: "string",
rootUrl: "string",
sourceRepoUrl: "string",
title: "string",
tokenUrl: "string",
toolchainIssuesEnabled: false,
type: "string",
},
toolchainId: "string",
cdToolchainToolGithubconsolidatedId: "string",
name: "string",
});
type: ibm:CdToolchainToolGithubconsolidated
properties:
cdToolchainToolGithubconsolidatedId: string
initialization:
autoInit: false
blindConnection: false
gitId: string
ownerId: string
privateRepo: false
repoName: string
repoUrl: string
rootUrl: string
sourceRepoUrl: string
title: string
type: string
name: string
parameters:
apiRootUrl: string
apiToken: string
authType: string
autoInit: false
blindConnection: false
defaultBranch: string
enableTraceability: false
gitId: string
integrationOwner: string
ownerId: string
privateRepo: false
repoId: string
repoName: string
repoUrl: string
rootUrl: string
sourceRepoUrl: string
title: string
tokenUrl: string
toolchainIssuesEnabled: false
type: string
toolchainId: string
CdToolchainToolGithubconsolidated Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CdToolchainToolGithubconsolidated resource accepts the following input properties:
- Initialization
Cd
Toolchain Tool Githubconsolidated Initialization - Nested schema for initialization:
- Parameters
Cd
Toolchain Tool Githubconsolidated Parameters - Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
- Toolchain
Id string - ID of the toolchain to bind the tool to.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- Cd
Toolchain stringTool Githubconsolidated Id - The unique identifier of the cd_toolchain_tool_githubconsolidated.
- Name string
- Name of the tool.
- Constraints: The maximum length is
128
characters. The minimum length is0
characters. The value must match regular expression/^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/
.
- Constraints: The maximum length is
- Initialization
Cd
Toolchain Tool Githubconsolidated Initialization Args - Nested schema for initialization:
- Parameters
Cd
Toolchain Tool Githubconsolidated Parameters Args - Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
- Toolchain
Id string - ID of the toolchain to bind the tool to.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- Cd
Toolchain stringTool Githubconsolidated Id - The unique identifier of the cd_toolchain_tool_githubconsolidated.
- Name string
- Name of the tool.
- Constraints: The maximum length is
128
characters. The minimum length is0
characters. The value must match regular expression/^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/
.
- Constraints: The maximum length is
- initialization
Cd
Toolchain Tool Githubconsolidated Initialization - Nested schema for initialization:
- parameters
Cd
Toolchain Tool Githubconsolidated Parameters - Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
- toolchain
Id String - ID of the toolchain to bind the tool to.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- cd
Toolchain StringTool Githubconsolidated Id - The unique identifier of the cd_toolchain_tool_githubconsolidated.
- name String
- Name of the tool.
- Constraints: The maximum length is
128
characters. The minimum length is0
characters. The value must match regular expression/^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/
.
- Constraints: The maximum length is
- initialization
Cd
Toolchain Tool Githubconsolidated Initialization - Nested schema for initialization:
- parameters
Cd
Toolchain Tool Githubconsolidated Parameters - Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
- toolchain
Id string - ID of the toolchain to bind the tool to.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- cd
Toolchain stringTool Githubconsolidated Id - The unique identifier of the cd_toolchain_tool_githubconsolidated.
- name string
- Name of the tool.
- Constraints: The maximum length is
128
characters. The minimum length is0
characters. The value must match regular expression/^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/
.
- Constraints: The maximum length is
- initialization
Cd
Toolchain Tool Githubconsolidated Initialization Args - Nested schema for initialization:
- parameters
Cd
Toolchain Tool Githubconsolidated Parameters Args - Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
- toolchain_
id str - ID of the toolchain to bind the tool to.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- cd_
toolchain_ strtool_ githubconsolidated_ id - The unique identifier of the cd_toolchain_tool_githubconsolidated.
- name str
- Name of the tool.
- Constraints: The maximum length is
128
characters. The minimum length is0
characters. The value must match regular expression/^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/
.
- Constraints: The maximum length is
- initialization Property Map
- Nested schema for initialization:
- parameters Property Map
- Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
- toolchain
Id String - ID of the toolchain to bind the tool to.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- cd
Toolchain StringTool Githubconsolidated Id - The unique identifier of the cd_toolchain_tool_githubconsolidated.
- name String
- Name of the tool.
- Constraints: The maximum length is
128
characters. The minimum length is0
characters. The value must match regular expression/^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/
.
- Constraints: The maximum length is
Outputs
All input properties are implicitly available as output properties. Additionally, the CdToolchainToolGithubconsolidated resource produces the following output properties:
- Crn string
- (String) Tool CRN.
- Href string
- (String) URI representing the tool.
- Id string
- The provider-assigned unique ID for this managed resource.
- Referents
List<Cd
Toolchain Tool Githubconsolidated Referent> - (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
- Resource
Group stringId - (String) Resource group where the tool is located.
- State string
- (String) Current configuration state of the tool.
- Constraints: Allowable values are:
configured
,configuring
,misconfigured
,unconfigured
.
- Constraints: Allowable values are:
- Tool
Id string - (String) Tool ID.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- Toolchain
Crn string - (String) CRN of toolchain which the tool is bound to.
- Updated
At string - (String) Latest tool update timestamp.
- Crn string
- (String) Tool CRN.
- Href string
- (String) URI representing the tool.
- Id string
- The provider-assigned unique ID for this managed resource.
- Referents
[]Cd
Toolchain Tool Githubconsolidated Referent - (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
- Resource
Group stringId - (String) Resource group where the tool is located.
- State string
- (String) Current configuration state of the tool.
- Constraints: Allowable values are:
configured
,configuring
,misconfigured
,unconfigured
.
- Constraints: Allowable values are:
- Tool
Id string - (String) Tool ID.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- Toolchain
Crn string - (String) CRN of toolchain which the tool is bound to.
- Updated
At string - (String) Latest tool update timestamp.
- crn String
- (String) Tool CRN.
- href String
- (String) URI representing the tool.
- id String
- The provider-assigned unique ID for this managed resource.
- referents
List<Cd
Toolchain Tool Githubconsolidated Referent> - (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
- resource
Group StringId - (String) Resource group where the tool is located.
- state String
- (String) Current configuration state of the tool.
- Constraints: Allowable values are:
configured
,configuring
,misconfigured
,unconfigured
.
- Constraints: Allowable values are:
- tool
Id String - (String) Tool ID.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- toolchain
Crn String - (String) CRN of toolchain which the tool is bound to.
- updated
At String - (String) Latest tool update timestamp.
- crn string
- (String) Tool CRN.
- href string
- (String) URI representing the tool.
- id string
- The provider-assigned unique ID for this managed resource.
- referents
Cd
Toolchain Tool Githubconsolidated Referent[] - (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
- resource
Group stringId - (String) Resource group where the tool is located.
- state string
- (String) Current configuration state of the tool.
- Constraints: Allowable values are:
configured
,configuring
,misconfigured
,unconfigured
.
- Constraints: Allowable values are:
- tool
Id string - (String) Tool ID.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- toolchain
Crn string - (String) CRN of toolchain which the tool is bound to.
- updated
At string - (String) Latest tool update timestamp.
- crn str
- (String) Tool CRN.
- href str
- (String) URI representing the tool.
- id str
- The provider-assigned unique ID for this managed resource.
- referents
Sequence[Cd
Toolchain Tool Githubconsolidated Referent] - (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
- resource_
group_ strid - (String) Resource group where the tool is located.
- state str
- (String) Current configuration state of the tool.
- Constraints: Allowable values are:
configured
,configuring
,misconfigured
,unconfigured
.
- Constraints: Allowable values are:
- tool_
id str - (String) Tool ID.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- toolchain_
crn str - (String) CRN of toolchain which the tool is bound to.
- updated_
at str - (String) Latest tool update timestamp.
- crn String
- (String) Tool CRN.
- href String
- (String) URI representing the tool.
- id String
- The provider-assigned unique ID for this managed resource.
- referents List<Property Map>
- (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
- resource
Group StringId - (String) Resource group where the tool is located.
- state String
- (String) Current configuration state of the tool.
- Constraints: Allowable values are:
configured
,configuring
,misconfigured
,unconfigured
.
- Constraints: Allowable values are:
- tool
Id String - (String) Tool ID.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- toolchain
Crn String - (String) CRN of toolchain which the tool is bound to.
- updated
At String - (String) Latest tool update timestamp.
Look up Existing CdToolchainToolGithubconsolidated Resource
Get an existing CdToolchainToolGithubconsolidated 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?: CdToolchainToolGithubconsolidatedState, opts?: CustomResourceOptions): CdToolchainToolGithubconsolidated
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cd_toolchain_tool_githubconsolidated_id: Optional[str] = None,
crn: Optional[str] = None,
href: Optional[str] = None,
initialization: Optional[CdToolchainToolGithubconsolidatedInitializationArgs] = None,
name: Optional[str] = None,
parameters: Optional[CdToolchainToolGithubconsolidatedParametersArgs] = None,
referents: Optional[Sequence[CdToolchainToolGithubconsolidatedReferentArgs]] = None,
resource_group_id: Optional[str] = None,
state: Optional[str] = None,
tool_id: Optional[str] = None,
toolchain_crn: Optional[str] = None,
toolchain_id: Optional[str] = None,
updated_at: Optional[str] = None) -> CdToolchainToolGithubconsolidated
func GetCdToolchainToolGithubconsolidated(ctx *Context, name string, id IDInput, state *CdToolchainToolGithubconsolidatedState, opts ...ResourceOption) (*CdToolchainToolGithubconsolidated, error)
public static CdToolchainToolGithubconsolidated Get(string name, Input<string> id, CdToolchainToolGithubconsolidatedState? state, CustomResourceOptions? opts = null)
public static CdToolchainToolGithubconsolidated get(String name, Output<String> id, CdToolchainToolGithubconsolidatedState state, CustomResourceOptions options)
resources: _: type: ibm:CdToolchainToolGithubconsolidated get: id: ${id}
- 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.
- Cd
Toolchain stringTool Githubconsolidated Id - The unique identifier of the cd_toolchain_tool_githubconsolidated.
- Crn string
- (String) Tool CRN.
- Href string
- (String) URI representing the tool.
- Initialization
Cd
Toolchain Tool Githubconsolidated Initialization - Nested schema for initialization:
- Name string
- Name of the tool.
- Constraints: The maximum length is
128
characters. The minimum length is0
characters. The value must match regular expression/^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/
.
- Constraints: The maximum length is
- Parameters
Cd
Toolchain Tool Githubconsolidated Parameters - Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
- Referents
List<Cd
Toolchain Tool Githubconsolidated Referent> - (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
- Resource
Group stringId - (String) Resource group where the tool is located.
- State string
- (String) Current configuration state of the tool.
- Constraints: Allowable values are:
configured
,configuring
,misconfigured
,unconfigured
.
- Constraints: Allowable values are:
- Tool
Id string - (String) Tool ID.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- Toolchain
Crn string - (String) CRN of toolchain which the tool is bound to.
- Toolchain
Id string - ID of the toolchain to bind the tool to.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- Updated
At string - (String) Latest tool update timestamp.
- Cd
Toolchain stringTool Githubconsolidated Id - The unique identifier of the cd_toolchain_tool_githubconsolidated.
- Crn string
- (String) Tool CRN.
- Href string
- (String) URI representing the tool.
- Initialization
Cd
Toolchain Tool Githubconsolidated Initialization Args - Nested schema for initialization:
- Name string
- Name of the tool.
- Constraints: The maximum length is
128
characters. The minimum length is0
characters. The value must match regular expression/^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/
.
- Constraints: The maximum length is
- Parameters
Cd
Toolchain Tool Githubconsolidated Parameters Args - Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
- Referents
[]Cd
Toolchain Tool Githubconsolidated Referent Args - (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
- Resource
Group stringId - (String) Resource group where the tool is located.
- State string
- (String) Current configuration state of the tool.
- Constraints: Allowable values are:
configured
,configuring
,misconfigured
,unconfigured
.
- Constraints: Allowable values are:
- Tool
Id string - (String) Tool ID.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- Toolchain
Crn string - (String) CRN of toolchain which the tool is bound to.
- Toolchain
Id string - ID of the toolchain to bind the tool to.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- Updated
At string - (String) Latest tool update timestamp.
- cd
Toolchain StringTool Githubconsolidated Id - The unique identifier of the cd_toolchain_tool_githubconsolidated.
- crn String
- (String) Tool CRN.
- href String
- (String) URI representing the tool.
- initialization
Cd
Toolchain Tool Githubconsolidated Initialization - Nested schema for initialization:
- name String
- Name of the tool.
- Constraints: The maximum length is
128
characters. The minimum length is0
characters. The value must match regular expression/^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/
.
- Constraints: The maximum length is
- parameters
Cd
Toolchain Tool Githubconsolidated Parameters - Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
- referents
List<Cd
Toolchain Tool Githubconsolidated Referent> - (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
- resource
Group StringId - (String) Resource group where the tool is located.
- state String
- (String) Current configuration state of the tool.
- Constraints: Allowable values are:
configured
,configuring
,misconfigured
,unconfigured
.
- Constraints: Allowable values are:
- tool
Id String - (String) Tool ID.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- toolchain
Crn String - (String) CRN of toolchain which the tool is bound to.
- toolchain
Id String - ID of the toolchain to bind the tool to.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- updated
At String - (String) Latest tool update timestamp.
- cd
Toolchain stringTool Githubconsolidated Id - The unique identifier of the cd_toolchain_tool_githubconsolidated.
- crn string
- (String) Tool CRN.
- href string
- (String) URI representing the tool.
- initialization
Cd
Toolchain Tool Githubconsolidated Initialization - Nested schema for initialization:
- name string
- Name of the tool.
- Constraints: The maximum length is
128
characters. The minimum length is0
characters. The value must match regular expression/^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/
.
- Constraints: The maximum length is
- parameters
Cd
Toolchain Tool Githubconsolidated Parameters - Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
- referents
Cd
Toolchain Tool Githubconsolidated Referent[] - (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
- resource
Group stringId - (String) Resource group where the tool is located.
- state string
- (String) Current configuration state of the tool.
- Constraints: Allowable values are:
configured
,configuring
,misconfigured
,unconfigured
.
- Constraints: Allowable values are:
- tool
Id string - (String) Tool ID.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- toolchain
Crn string - (String) CRN of toolchain which the tool is bound to.
- toolchain
Id string - ID of the toolchain to bind the tool to.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- updated
At string - (String) Latest tool update timestamp.
- cd_
toolchain_ strtool_ githubconsolidated_ id - The unique identifier of the cd_toolchain_tool_githubconsolidated.
- crn str
- (String) Tool CRN.
- href str
- (String) URI representing the tool.
- initialization
Cd
Toolchain Tool Githubconsolidated Initialization Args - Nested schema for initialization:
- name str
- Name of the tool.
- Constraints: The maximum length is
128
characters. The minimum length is0
characters. The value must match regular expression/^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/
.
- Constraints: The maximum length is
- parameters
Cd
Toolchain Tool Githubconsolidated Parameters Args - Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
- referents
Sequence[Cd
Toolchain Tool Githubconsolidated Referent Args] - (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
- resource_
group_ strid - (String) Resource group where the tool is located.
- state str
- (String) Current configuration state of the tool.
- Constraints: Allowable values are:
configured
,configuring
,misconfigured
,unconfigured
.
- Constraints: Allowable values are:
- tool_
id str - (String) Tool ID.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- toolchain_
crn str - (String) CRN of toolchain which the tool is bound to.
- toolchain_
id str - ID of the toolchain to bind the tool to.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- updated_
at str - (String) Latest tool update timestamp.
- cd
Toolchain StringTool Githubconsolidated Id - The unique identifier of the cd_toolchain_tool_githubconsolidated.
- crn String
- (String) Tool CRN.
- href String
- (String) URI representing the tool.
- initialization Property Map
- Nested schema for initialization:
- name String
- Name of the tool.
- Constraints: The maximum length is
128
characters. The minimum length is0
characters. The value must match regular expression/^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/
.
- Constraints: The maximum length is
- parameters Property Map
- Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested schema for parameters:
- referents List<Property Map>
- (List) Information on URIs to access this resource through the UI or API. Nested schema for referent:
- resource
Group StringId - (String) Resource group where the tool is located.
- state String
- (String) Current configuration state of the tool.
- Constraints: Allowable values are:
configured
,configuring
,misconfigured
,unconfigured
.
- Constraints: Allowable values are:
- tool
Id String - (String) Tool ID.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- toolchain
Crn String - (String) CRN of toolchain which the tool is bound to.
- toolchain
Id String - ID of the toolchain to bind the tool to.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$/
.
- Constraints: The maximum length is
- updated
At String - (String) Latest tool update timestamp.
Supporting Types
CdToolchainToolGithubconsolidatedInitialization, CdToolchainToolGithubconsolidatedInitializationArgs
- Type string
- The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.
- Constraints: Allowable values are:
new
,fork
,clone
,link
,new_if_not_exists
,clone_if_not_exists
,fork_if_not_exists
.
- Constraints: Allowable values are:
- Auto
Init bool - Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Blind
Connection bool - Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Git
Id string - Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
- Owner
Id string - The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- Private
Repo bool - Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Repo
Name string - The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- Repo
Url string - The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
- Root
Url string - The Root URL of the server. e.g. https://github.example.com.
- Source
Repo stringUrl - The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
- Title string
- The title of the server. e.g. My GitHub Enterprise Server.
- Type string
- The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.
- Constraints: Allowable values are:
new
,fork
,clone
,link
,new_if_not_exists
,clone_if_not_exists
,fork_if_not_exists
.
- Constraints: Allowable values are:
- Auto
Init bool - Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Blind
Connection bool - Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Git
Id string - Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
- Owner
Id string - The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- Private
Repo bool - Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Repo
Name string - The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- Repo
Url string - The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
- Root
Url string - The Root URL of the server. e.g. https://github.example.com.
- Source
Repo stringUrl - The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
- Title string
- The title of the server. e.g. My GitHub Enterprise Server.
- type String
- The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.
- Constraints: Allowable values are:
new
,fork
,clone
,link
,new_if_not_exists
,clone_if_not_exists
,fork_if_not_exists
.
- Constraints: Allowable values are:
- auto
Init Boolean - Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- blind
Connection Boolean - Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.
- Constraints: The default value is
false
.
- Constraints: The default value is
- git
Id String - Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
- owner
Id String - The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- private
Repo Boolean - Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- repo
Name String - The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- repo
Url String - The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
- root
Url String - The Root URL of the server. e.g. https://github.example.com.
- source
Repo StringUrl - The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
- title String
- The title of the server. e.g. My GitHub Enterprise Server.
- type string
- The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.
- Constraints: Allowable values are:
new
,fork
,clone
,link
,new_if_not_exists
,clone_if_not_exists
,fork_if_not_exists
.
- Constraints: Allowable values are:
- auto
Init boolean - Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- blind
Connection boolean - Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.
- Constraints: The default value is
false
.
- Constraints: The default value is
- git
Id string - Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
- owner
Id string - The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- private
Repo boolean - Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- repo
Name string - The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- repo
Url string - The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
- root
Url string - The Root URL of the server. e.g. https://github.example.com.
- source
Repo stringUrl - The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
- title string
- The title of the server. e.g. My GitHub Enterprise Server.
- type str
- The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.
- Constraints: Allowable values are:
new
,fork
,clone
,link
,new_if_not_exists
,clone_if_not_exists
,fork_if_not_exists
.
- Constraints: Allowable values are:
- auto_
init bool - Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- blind_
connection bool - Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.
- Constraints: The default value is
false
.
- Constraints: The default value is
- git_
id str - Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
- owner_
id str - The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- private_
repo bool - Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- repo_
name str - The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- repo_
url str - The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
- root_
url str - The Root URL of the server. e.g. https://github.example.com.
- source_
repo_ strurl - The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
- title str
- The title of the server. e.g. My GitHub Enterprise Server.
- type String
- The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.
- Constraints: Allowable values are:
new
,fork
,clone
,link
,new_if_not_exists
,clone_if_not_exists
,fork_if_not_exists
.
- Constraints: Allowable values are:
- auto
Init Boolean - Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- blind
Connection Boolean - Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.
- Constraints: The default value is
false
.
- Constraints: The default value is
- git
Id String - Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
- owner
Id String - The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- private
Repo Boolean - Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- repo
Name String - The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- repo
Url String - The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
- root
Url String - The Root URL of the server. e.g. https://github.example.com.
- source
Repo StringUrl - The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
- title String
- The title of the server. e.g. My GitHub Enterprise Server.
CdToolchainToolGithubconsolidatedParameters, CdToolchainToolGithubconsolidatedParametersArgs
- Api
Root stringUrl - The API root URL for the GitHub server.
- Api
Token string - Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.
- Auth
Type string - Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.
- Constraints: Allowable values are:
oauth
,pat
.
- Constraints: Allowable values are:
- Auto
Init bool - Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Blind
Connection bool - Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Default
Branch string - The default branch of the git repository.
- Enable
Traceability bool - Set this value to 'true' to track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Git
Id string - Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
- Integration
Owner string - Select the user which git operations will be performed as.
- Owner
Id string - The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- Private
Repo bool - Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Repo
Id string - The ID of the GitHub repository.
- Repo
Name string - The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- Repo
Url string - The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
- Root
Url string - The Root URL of the server. e.g. https://github.example.com.
- Source
Repo stringUrl - The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
- Title string
- The title of the server. e.g. My GitHub Enterprise Server.
- Token
Url string - The token URL used for authorizing with the GitHub server.
- Toolchain
Issues boolEnabled - Setting this value to true will enable issues on the GitHub repository and add an issues tool card to the toolchain. Setting the value to false will remove the tool card from the toolchain, but will not impact whether or not issues are enabled on the GitHub repository itself.
- Constraints: The default value is
true
.
- Constraints: The default value is
- Type string
- The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.
- Constraints: Allowable values are:
new
,fork
,clone
,link
,new_if_not_exists
,clone_if_not_exists
,fork_if_not_exists
.
- Constraints: Allowable values are:
- Api
Root stringUrl - The API root URL for the GitHub server.
- Api
Token string - Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.
- Auth
Type string - Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.
- Constraints: Allowable values are:
oauth
,pat
.
- Constraints: Allowable values are:
- Auto
Init bool - Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Blind
Connection bool - Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Default
Branch string - The default branch of the git repository.
- Enable
Traceability bool - Set this value to 'true' to track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Git
Id string - Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
- Integration
Owner string - Select the user which git operations will be performed as.
- Owner
Id string - The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- Private
Repo bool - Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Repo
Id string - The ID of the GitHub repository.
- Repo
Name string - The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- Repo
Url string - The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
- Root
Url string - The Root URL of the server. e.g. https://github.example.com.
- Source
Repo stringUrl - The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
- Title string
- The title of the server. e.g. My GitHub Enterprise Server.
- Token
Url string - The token URL used for authorizing with the GitHub server.
- Toolchain
Issues boolEnabled - Setting this value to true will enable issues on the GitHub repository and add an issues tool card to the toolchain. Setting the value to false will remove the tool card from the toolchain, but will not impact whether or not issues are enabled on the GitHub repository itself.
- Constraints: The default value is
true
.
- Constraints: The default value is
- Type string
- The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.
- Constraints: Allowable values are:
new
,fork
,clone
,link
,new_if_not_exists
,clone_if_not_exists
,fork_if_not_exists
.
- Constraints: Allowable values are:
- api
Root StringUrl - The API root URL for the GitHub server.
- api
Token String - Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.
- auth
Type String - Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.
- Constraints: Allowable values are:
oauth
,pat
.
- Constraints: Allowable values are:
- auto
Init Boolean - Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- blind
Connection Boolean - Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.
- Constraints: The default value is
false
.
- Constraints: The default value is
- default
Branch String - The default branch of the git repository.
- enable
Traceability Boolean - Set this value to 'true' to track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues.
- Constraints: The default value is
false
.
- Constraints: The default value is
- git
Id String - Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
- integration
Owner String - Select the user which git operations will be performed as.
- owner
Id String - The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- private
Repo Boolean - Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- repo
Id String - The ID of the GitHub repository.
- repo
Name String - The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- repo
Url String - The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
- root
Url String - The Root URL of the server. e.g. https://github.example.com.
- source
Repo StringUrl - The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
- title String
- The title of the server. e.g. My GitHub Enterprise Server.
- token
Url String - The token URL used for authorizing with the GitHub server.
- toolchain
Issues BooleanEnabled - Setting this value to true will enable issues on the GitHub repository and add an issues tool card to the toolchain. Setting the value to false will remove the tool card from the toolchain, but will not impact whether or not issues are enabled on the GitHub repository itself.
- Constraints: The default value is
true
.
- Constraints: The default value is
- type String
- The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.
- Constraints: Allowable values are:
new
,fork
,clone
,link
,new_if_not_exists
,clone_if_not_exists
,fork_if_not_exists
.
- Constraints: Allowable values are:
- api
Root stringUrl - The API root URL for the GitHub server.
- api
Token string - Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.
- auth
Type string - Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.
- Constraints: Allowable values are:
oauth
,pat
.
- Constraints: Allowable values are:
- auto
Init boolean - Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- blind
Connection boolean - Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.
- Constraints: The default value is
false
.
- Constraints: The default value is
- default
Branch string - The default branch of the git repository.
- enable
Traceability boolean - Set this value to 'true' to track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues.
- Constraints: The default value is
false
.
- Constraints: The default value is
- git
Id string - Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
- integration
Owner string - Select the user which git operations will be performed as.
- owner
Id string - The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- private
Repo boolean - Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- repo
Id string - The ID of the GitHub repository.
- repo
Name string - The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- repo
Url string - The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
- root
Url string - The Root URL of the server. e.g. https://github.example.com.
- source
Repo stringUrl - The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
- title string
- The title of the server. e.g. My GitHub Enterprise Server.
- token
Url string - The token URL used for authorizing with the GitHub server.
- toolchain
Issues booleanEnabled - Setting this value to true will enable issues on the GitHub repository and add an issues tool card to the toolchain. Setting the value to false will remove the tool card from the toolchain, but will not impact whether or not issues are enabled on the GitHub repository itself.
- Constraints: The default value is
true
.
- Constraints: The default value is
- type string
- The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.
- Constraints: Allowable values are:
new
,fork
,clone
,link
,new_if_not_exists
,clone_if_not_exists
,fork_if_not_exists
.
- Constraints: Allowable values are:
- api_
root_ strurl - The API root URL for the GitHub server.
- api_
token str - Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.
- auth_
type str - Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.
- Constraints: Allowable values are:
oauth
,pat
.
- Constraints: Allowable values are:
- auto_
init bool - Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- blind_
connection bool - Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.
- Constraints: The default value is
false
.
- Constraints: The default value is
- default_
branch str - The default branch of the git repository.
- enable_
traceability bool - Set this value to 'true' to track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues.
- Constraints: The default value is
false
.
- Constraints: The default value is
- git_
id str - Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
- integration_
owner str - Select the user which git operations will be performed as.
- owner_
id str - The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- private_
repo bool - Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- repo_
id str - The ID of the GitHub repository.
- repo_
name str - The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- repo_
url str - The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
- root_
url str - The Root URL of the server. e.g. https://github.example.com.
- source_
repo_ strurl - The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
- title str
- The title of the server. e.g. My GitHub Enterprise Server.
- token_
url str - The token URL used for authorizing with the GitHub server.
- toolchain_
issues_ boolenabled - Setting this value to true will enable issues on the GitHub repository and add an issues tool card to the toolchain. Setting the value to false will remove the tool card from the toolchain, but will not impact whether or not issues are enabled on the GitHub repository itself.
- Constraints: The default value is
true
.
- Constraints: The default value is
- type str
- The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.
- Constraints: Allowable values are:
new
,fork
,clone
,link
,new_if_not_exists
,clone_if_not_exists
,fork_if_not_exists
.
- Constraints: Allowable values are:
- api
Root StringUrl - The API root URL for the GitHub server.
- api
Token String - Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.
- auth
Type String - Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.
- Constraints: Allowable values are:
oauth
,pat
.
- Constraints: Allowable values are:
- auto
Init Boolean - Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- blind
Connection Boolean - Setting this value to true means the server is not addressable on the public internet. IBM Cloud will not be able to validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.
- Constraints: The default value is
false
.
- Constraints: The default value is
- default
Branch String - The default branch of the git repository.
- enable
Traceability Boolean - Set this value to 'true' to track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues.
- Constraints: The default value is
false
.
- Constraints: The default value is
- git
Id String - Set this value to 'github' for github.com, or 'githubcustom' for a custom GitHub Enterprise server.
- integration
Owner String - Select the user which git operations will be performed as.
- owner
Id String - The GitHub user or organization that owns the repository. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- private
Repo Boolean - Set this value to 'true' to make the repository private when creating a new repository or when cloning or forking a repository. This parameter is not used when linking to an existing repository.
- Constraints: The default value is
false
.
- Constraints: The default value is
- repo
Id String - The ID of the GitHub repository.
- repo
Name String - The name of the new GitHub repository to create. This parameter is required when creating a new repository, cloning, or forking a repository. The value will be computed when linking to an existing repository.
- repo
Url String - The URL of the GitHub repository for this tool integration. This parameter is required when linking to an existing repository. The value will be computed when creating a new repository, cloning, or forking a repository.
- root
Url String - The Root URL of the server. e.g. https://github.example.com.
- source
Repo StringUrl - The URL of the repository that you are forking or cloning. This parameter is required when forking or cloning a repository. It is not used when creating a new repository or linking to an existing repository.
- title String
- The title of the server. e.g. My GitHub Enterprise Server.
- token
Url String - The token URL used for authorizing with the GitHub server.
- toolchain
Issues BooleanEnabled - Setting this value to true will enable issues on the GitHub repository and add an issues tool card to the toolchain. Setting the value to false will remove the tool card from the toolchain, but will not impact whether or not issues are enabled on the GitHub repository itself.
- Constraints: The default value is
true
.
- Constraints: The default value is
- type String
- The operation that should be performed to initialize the new tool integration. Use 'new' or 'new_if_not_exists' to create a new git repository, 'clone' or 'clone_if_not_exists' to clone an existing repository into a new git repository, 'fork' or 'fork_if_not_exists' to fork an existing git repository, or 'link' to link to an existing git repository. If you attempt to apply a resource with type 'new', 'clone', or 'fork' when the target repo already exists, the attempt will fail. If you apply a resource with type 'new_if_not_exists`, 'clone_if_not_exists', or 'fork_if_not_exists' when the target repo already exists, the existing repo will be used as-is.
- Constraints: Allowable values are:
new
,fork
,clone
,link
,new_if_not_exists
,clone_if_not_exists
,fork_if_not_exists
.
- Constraints: Allowable values are:
CdToolchainToolGithubconsolidatedReferent, CdToolchainToolGithubconsolidatedReferentArgs
Import
You can import the ibm_cd_toolchain_tool_githubconsolidated
resource by using id
.
The id
property can be formed from toolchain_id
, and tool_id
in the following format:
<toolchain_id>/<tool_id>
toolchain_id
: A string. ID of the toolchain to bind the tool to.tool_id
: A string. ID of the tool bound to the toolchain.
Syntax
$ pulumi import ibm:index/cdToolchainToolGithubconsolidated:CdToolchainToolGithubconsolidated cd_toolchain_tool_githubconsolidated <toolchain_id>/<tool_id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.