harness.platform.JenkinsConnector
Explore with Pulumi AI
Resource for creating a Jenkins connector.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Harness = Lbrlabs.PulumiPackage.Harness;
return await Deployment.RunAsync(() =>
{
// Auth mechanism bearer token
var test = new Harness.Platform.JenkinsConnector("test", new()
{
Auth = new Harness.Platform.Inputs.JenkinsConnectorAuthArgs
{
JenkinsBearerToken = new Harness.Platform.Inputs.JenkinsConnectorAuthJenkinsBearerTokenArgs
{
TokenRef = $"account.{harness_platform_secret_text.Test.Id}",
},
Type = "Bearer Token(HTTP Header)",
},
DelegateSelectors = new[]
{
"harness-delegate",
},
Description = "test",
Identifier = "identifier",
JenkinsUrl = "https://jenkinss.com/",
Tags = new[]
{
"foo:bar",
},
});
});
package main
import (
"fmt"
"github.com/lbrlabs/pulumi-harness/sdk/go/harness/platform"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := platform.NewJenkinsConnector(ctx, "test", &platform.JenkinsConnectorArgs{
Auth: &platform.JenkinsConnectorAuthArgs{
JenkinsBearerToken: &platform.JenkinsConnectorAuthJenkinsBearerTokenArgs{
TokenRef: pulumi.String(fmt.Sprintf("account.%v", harness_platform_secret_text.Test.Id)),
},
Type: pulumi.String("Bearer Token(HTTP Header)"),
},
DelegateSelectors: pulumi.StringArray{
pulumi.String("harness-delegate"),
},
Description: pulumi.String("test"),
Identifier: pulumi.String("identifier"),
JenkinsUrl: pulumi.String("https://jenkinss.com/"),
Tags: pulumi.StringArray{
pulumi.String("foo:bar"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.platform.JenkinsConnector;
import com.pulumi.harness.platform.JenkinsConnectorArgs;
import com.pulumi.harness.platform.inputs.JenkinsConnectorAuthArgs;
import com.pulumi.harness.platform.inputs.JenkinsConnectorAuthJenkinsBearerTokenArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var test = new JenkinsConnector("test", JenkinsConnectorArgs.builder()
.auth(JenkinsConnectorAuthArgs.builder()
.jenkinsBearerToken(JenkinsConnectorAuthJenkinsBearerTokenArgs.builder()
.tokenRef(String.format("account.%s", harness_platform_secret_text.test().id()))
.build())
.type("Bearer Token(HTTP Header)")
.build())
.delegateSelectors("harness-delegate")
.description("test")
.identifier("identifier")
.jenkinsUrl("https://jenkinss.com/")
.tags("foo:bar")
.build());
}
}
import pulumi
import lbrlabs_pulumi_harness as harness
# Auth mechanism bearer token
test = harness.platform.JenkinsConnector("test",
auth=harness.platform.JenkinsConnectorAuthArgs(
jenkins_bearer_token=harness.platform.JenkinsConnectorAuthJenkinsBearerTokenArgs(
token_ref=f"account.{harness_platform_secret_text['test']['id']}",
),
type="Bearer Token(HTTP Header)",
),
delegate_selectors=["harness-delegate"],
description="test",
identifier="identifier",
jenkins_url="https://jenkinss.com/",
tags=["foo:bar"])
import * as pulumi from "@pulumi/pulumi";
import * as harness from "@lbrlabs/pulumi-harness";
// Auth mechanism bearer token
const test = new harness.platform.JenkinsConnector("test", {
auth: {
jenkinsBearerToken: {
tokenRef: `account.${harness_platform_secret_text.test.id}`,
},
type: "Bearer Token(HTTP Header)",
},
delegateSelectors: ["harness-delegate"],
description: "test",
identifier: "identifier",
jenkinsUrl: "https://jenkinss.com/",
tags: ["foo:bar"],
});
resources:
# Auth mechanism bearer token
test:
type: harness:platform:JenkinsConnector
properties:
auth:
jenkinsBearerToken:
tokenRef: account.${harness_platform_secret_text.test.id}
type: Bearer Token(HTTP Header)
delegateSelectors:
- harness-delegate
description: test
identifier: identifier
jenkinsUrl: https://jenkinss.com/
tags:
- foo:bar
Create JenkinsConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new JenkinsConnector(name: string, args: JenkinsConnectorArgs, opts?: CustomResourceOptions);
@overload
def JenkinsConnector(resource_name: str,
args: JenkinsConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def JenkinsConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
identifier: Optional[str] = None,
jenkins_url: Optional[str] = None,
auth: Optional[JenkinsConnectorAuthArgs] = None,
delegate_selectors: Optional[Sequence[str]] = None,
description: Optional[str] = None,
name: Optional[str] = None,
org_id: Optional[str] = None,
project_id: Optional[str] = None,
tags: Optional[Sequence[str]] = None)
func NewJenkinsConnector(ctx *Context, name string, args JenkinsConnectorArgs, opts ...ResourceOption) (*JenkinsConnector, error)
public JenkinsConnector(string name, JenkinsConnectorArgs args, CustomResourceOptions? opts = null)
public JenkinsConnector(String name, JenkinsConnectorArgs args)
public JenkinsConnector(String name, JenkinsConnectorArgs args, CustomResourceOptions options)
type: harness:platform:JenkinsConnector
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 JenkinsConnectorArgs
- 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 JenkinsConnectorArgs
- 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 JenkinsConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args JenkinsConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args JenkinsConnectorArgs
- 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 jenkinsConnectorResource = new Harness.Platform.JenkinsConnector("jenkinsConnectorResource", new()
{
Identifier = "string",
JenkinsUrl = "string",
Auth = new Harness.Platform.Inputs.JenkinsConnectorAuthArgs
{
Type = "string",
JenkinsBearerToken = new Harness.Platform.Inputs.JenkinsConnectorAuthJenkinsBearerTokenArgs
{
TokenRef = "string",
},
JenkinsUserNamePassword = new Harness.Platform.Inputs.JenkinsConnectorAuthJenkinsUserNamePasswordArgs
{
PasswordRef = "string",
Username = "string",
UsernameRef = "string",
},
},
DelegateSelectors = new[]
{
"string",
},
Description = "string",
Name = "string",
OrgId = "string",
ProjectId = "string",
Tags = new[]
{
"string",
},
});
example, err := platform.NewJenkinsConnector(ctx, "jenkinsConnectorResource", &platform.JenkinsConnectorArgs{
Identifier: pulumi.String("string"),
JenkinsUrl: pulumi.String("string"),
Auth: &platform.JenkinsConnectorAuthArgs{
Type: pulumi.String("string"),
JenkinsBearerToken: &platform.JenkinsConnectorAuthJenkinsBearerTokenArgs{
TokenRef: pulumi.String("string"),
},
JenkinsUserNamePassword: &platform.JenkinsConnectorAuthJenkinsUserNamePasswordArgs{
PasswordRef: pulumi.String("string"),
Username: pulumi.String("string"),
UsernameRef: pulumi.String("string"),
},
},
DelegateSelectors: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
Name: pulumi.String("string"),
OrgId: pulumi.String("string"),
ProjectId: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
var jenkinsConnectorResource = new JenkinsConnector("jenkinsConnectorResource", JenkinsConnectorArgs.builder()
.identifier("string")
.jenkinsUrl("string")
.auth(JenkinsConnectorAuthArgs.builder()
.type("string")
.jenkinsBearerToken(JenkinsConnectorAuthJenkinsBearerTokenArgs.builder()
.tokenRef("string")
.build())
.jenkinsUserNamePassword(JenkinsConnectorAuthJenkinsUserNamePasswordArgs.builder()
.passwordRef("string")
.username("string")
.usernameRef("string")
.build())
.build())
.delegateSelectors("string")
.description("string")
.name("string")
.orgId("string")
.projectId("string")
.tags("string")
.build());
jenkins_connector_resource = harness.platform.JenkinsConnector("jenkinsConnectorResource",
identifier="string",
jenkins_url="string",
auth=harness.platform.JenkinsConnectorAuthArgs(
type="string",
jenkins_bearer_token=harness.platform.JenkinsConnectorAuthJenkinsBearerTokenArgs(
token_ref="string",
),
jenkins_user_name_password=harness.platform.JenkinsConnectorAuthJenkinsUserNamePasswordArgs(
password_ref="string",
username="string",
username_ref="string",
),
),
delegate_selectors=["string"],
description="string",
name="string",
org_id="string",
project_id="string",
tags=["string"])
const jenkinsConnectorResource = new harness.platform.JenkinsConnector("jenkinsConnectorResource", {
identifier: "string",
jenkinsUrl: "string",
auth: {
type: "string",
jenkinsBearerToken: {
tokenRef: "string",
},
jenkinsUserNamePassword: {
passwordRef: "string",
username: "string",
usernameRef: "string",
},
},
delegateSelectors: ["string"],
description: "string",
name: "string",
orgId: "string",
projectId: "string",
tags: ["string"],
});
type: harness:platform:JenkinsConnector
properties:
auth:
jenkinsBearerToken:
tokenRef: string
jenkinsUserNamePassword:
passwordRef: string
username: string
usernameRef: string
type: string
delegateSelectors:
- string
description: string
identifier: string
jenkinsUrl: string
name: string
orgId: string
projectId: string
tags:
- string
JenkinsConnector 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 JenkinsConnector resource accepts the following input properties:
- Identifier string
- Unique identifier of the resource.
- Jenkins
Url string - Jenkins Url.
- Auth
Lbrlabs.
Pulumi Package. Harness. Platform. Inputs. Jenkins Connector Auth - This entity contains the details for Jenkins Authentication.
- Delegate
Selectors List<string> - Tags to filter delegates for connection.
- Description string
- Description of the resource.
- Name string
- Name of the resource.
- Org
Id string - Unique identifier of the organization.
- Project
Id string - Unique identifier of the project.
- List<string>
- Tags to associate with the resource.
- Identifier string
- Unique identifier of the resource.
- Jenkins
Url string - Jenkins Url.
- Auth
Jenkins
Connector Auth Args - This entity contains the details for Jenkins Authentication.
- Delegate
Selectors []string - Tags to filter delegates for connection.
- Description string
- Description of the resource.
- Name string
- Name of the resource.
- Org
Id string - Unique identifier of the organization.
- Project
Id string - Unique identifier of the project.
- []string
- Tags to associate with the resource.
- identifier String
- Unique identifier of the resource.
- jenkins
Url String - Jenkins Url.
- auth
Jenkins
Connector Auth - This entity contains the details for Jenkins Authentication.
- delegate
Selectors List<String> - Tags to filter delegates for connection.
- description String
- Description of the resource.
- name String
- Name of the resource.
- org
Id String - Unique identifier of the organization.
- project
Id String - Unique identifier of the project.
- List<String>
- Tags to associate with the resource.
- identifier string
- Unique identifier of the resource.
- jenkins
Url string - Jenkins Url.
- auth
Jenkins
Connector Auth - This entity contains the details for Jenkins Authentication.
- delegate
Selectors string[] - Tags to filter delegates for connection.
- description string
- Description of the resource.
- name string
- Name of the resource.
- org
Id string - Unique identifier of the organization.
- project
Id string - Unique identifier of the project.
- string[]
- Tags to associate with the resource.
- identifier str
- Unique identifier of the resource.
- jenkins_
url str - Jenkins Url.
- auth
Jenkins
Connector Auth Args - This entity contains the details for Jenkins Authentication.
- delegate_
selectors Sequence[str] - Tags to filter delegates for connection.
- 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.
- Sequence[str]
- Tags to associate with the resource.
- identifier String
- Unique identifier of the resource.
- jenkins
Url String - Jenkins Url.
- auth Property Map
- This entity contains the details for Jenkins Authentication.
- delegate
Selectors List<String> - Tags to filter delegates for connection.
- description String
- Description of the resource.
- name String
- Name of the resource.
- org
Id String - Unique identifier of the organization.
- project
Id String - Unique identifier of the project.
- List<String>
- Tags to associate with the resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the JenkinsConnector 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 JenkinsConnector Resource
Get an existing JenkinsConnector 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?: JenkinsConnectorState, opts?: CustomResourceOptions): JenkinsConnector
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auth: Optional[JenkinsConnectorAuthArgs] = None,
delegate_selectors: Optional[Sequence[str]] = None,
description: Optional[str] = None,
identifier: Optional[str] = None,
jenkins_url: Optional[str] = None,
name: Optional[str] = None,
org_id: Optional[str] = None,
project_id: Optional[str] = None,
tags: Optional[Sequence[str]] = None) -> JenkinsConnector
func GetJenkinsConnector(ctx *Context, name string, id IDInput, state *JenkinsConnectorState, opts ...ResourceOption) (*JenkinsConnector, error)
public static JenkinsConnector Get(string name, Input<string> id, JenkinsConnectorState? state, CustomResourceOptions? opts = null)
public static JenkinsConnector get(String name, Output<String> id, JenkinsConnectorState 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.
- Auth
Lbrlabs.
Pulumi Package. Harness. Platform. Inputs. Jenkins Connector Auth - This entity contains the details for Jenkins Authentication.
- Delegate
Selectors List<string> - Tags to filter delegates for connection.
- Description string
- Description of the resource.
- Identifier string
- Unique identifier of the resource.
- Jenkins
Url string - Jenkins Url.
- Name string
- Name of the resource.
- Org
Id string - Unique identifier of the organization.
- Project
Id string - Unique identifier of the project.
- List<string>
- Tags to associate with the resource.
- Auth
Jenkins
Connector Auth Args - This entity contains the details for Jenkins Authentication.
- Delegate
Selectors []string - Tags to filter delegates for connection.
- Description string
- Description of the resource.
- Identifier string
- Unique identifier of the resource.
- Jenkins
Url string - Jenkins Url.
- Name string
- Name of the resource.
- Org
Id string - Unique identifier of the organization.
- Project
Id string - Unique identifier of the project.
- []string
- Tags to associate with the resource.
- auth
Jenkins
Connector Auth - This entity contains the details for Jenkins Authentication.
- delegate
Selectors List<String> - Tags to filter delegates for connection.
- description String
- Description of the resource.
- identifier String
- Unique identifier of the resource.
- jenkins
Url String - Jenkins Url.
- name String
- Name of the resource.
- org
Id String - Unique identifier of the organization.
- project
Id String - Unique identifier of the project.
- List<String>
- Tags to associate with the resource.
- auth
Jenkins
Connector Auth - This entity contains the details for Jenkins Authentication.
- delegate
Selectors string[] - Tags to filter delegates for connection.
- description string
- Description of the resource.
- identifier string
- Unique identifier of the resource.
- jenkins
Url string - Jenkins Url.
- name string
- Name of the resource.
- org
Id string - Unique identifier of the organization.
- project
Id string - Unique identifier of the project.
- string[]
- Tags to associate with the resource.
- auth
Jenkins
Connector Auth Args - This entity contains the details for Jenkins Authentication.
- delegate_
selectors Sequence[str] - Tags to filter delegates for connection.
- description str
- Description of the resource.
- identifier str
- Unique identifier of the resource.
- jenkins_
url str - Jenkins Url.
- name str
- Name of the resource.
- org_
id str - Unique identifier of the organization.
- project_
id str - Unique identifier of the project.
- Sequence[str]
- Tags to associate with the resource.
- auth Property Map
- This entity contains the details for Jenkins Authentication.
- delegate
Selectors List<String> - Tags to filter delegates for connection.
- description String
- Description of the resource.
- identifier String
- Unique identifier of the resource.
- jenkins
Url String - Jenkins Url.
- name String
- Name of the resource.
- org
Id String - Unique identifier of the organization.
- project
Id String - Unique identifier of the project.
- List<String>
- Tags to associate with the resource.
Supporting Types
JenkinsConnectorAuth, JenkinsConnectorAuthArgs
- Type string
- Can be one of UsernamePassword, Anonymous, Bearer Token(HTTP Header)
- Jenkins
Bearer Lbrlabs.Token Pulumi Package. Harness. Platform. Inputs. Jenkins Connector Auth Jenkins Bearer Token - Authenticate to App Dynamics using bearer token.
- Jenkins
User Lbrlabs.Name Password Pulumi Package. Harness. Platform. Inputs. Jenkins Connector Auth Jenkins User Name Password - Authenticate to App Dynamics using user name and password.
- Type string
- Can be one of UsernamePassword, Anonymous, Bearer Token(HTTP Header)
- Jenkins
Bearer JenkinsToken Connector Auth Jenkins Bearer Token - Authenticate to App Dynamics using bearer token.
- Jenkins
User JenkinsName Password Connector Auth Jenkins User Name Password - Authenticate to App Dynamics using user name and password.
- type String
- Can be one of UsernamePassword, Anonymous, Bearer Token(HTTP Header)
- jenkins
Bearer JenkinsToken Connector Auth Jenkins Bearer Token - Authenticate to App Dynamics using bearer token.
- jenkins
User JenkinsName Password Connector Auth Jenkins User Name Password - Authenticate to App Dynamics using user name and password.
- type string
- Can be one of UsernamePassword, Anonymous, Bearer Token(HTTP Header)
- jenkins
Bearer JenkinsToken Connector Auth Jenkins Bearer Token - Authenticate to App Dynamics using bearer token.
- jenkins
User JenkinsName Password Connector Auth Jenkins User Name Password - Authenticate to App Dynamics using user name and password.
- type str
- Can be one of UsernamePassword, Anonymous, Bearer Token(HTTP Header)
- jenkins_
bearer_ Jenkinstoken Connector Auth Jenkins Bearer Token - Authenticate to App Dynamics using bearer token.
- jenkins_
user_ Jenkinsname_ password Connector Auth Jenkins User Name Password - Authenticate to App Dynamics using user name and password.
- type String
- Can be one of UsernamePassword, Anonymous, Bearer Token(HTTP Header)
- jenkins
Bearer Property MapToken - Authenticate to App Dynamics using bearer token.
- jenkins
User Property MapName Password - Authenticate to App Dynamics using user name and password.
JenkinsConnectorAuthJenkinsBearerToken, JenkinsConnectorAuthJenkinsBearerTokenArgs
- Token
Ref string
- Token
Ref string
- token
Ref String
- token
Ref string
- token_
ref str
- token
Ref String
JenkinsConnectorAuthJenkinsUserNamePassword, JenkinsConnectorAuthJenkinsUserNamePasswordArgs
- Password
Ref string - Username string
- Username
Ref string
- Password
Ref string - Username string
- Username
Ref string
- password
Ref String - username String
- username
Ref String
- password
Ref string - username string
- username
Ref string
- password_
ref str - username str
- username_
ref str
- password
Ref String - username String
- username
Ref String
Import
Import account level jenkins connector
$ pulumi import harness:platform/jenkinsConnector:JenkinsConnector example <connector_id>
Import org level jenkins connector
$ pulumi import harness:platform/jenkinsConnector:JenkinsConnector example <ord_id>/<connector_id>
Import project level jenkins connector
$ pulumi import harness:platform/jenkinsConnector:JenkinsConnector example <org_id>/<project_id>/<connector_id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- harness lbrlabs/pulumi-harness
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
harness
Terraform Provider.