1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. JenkinsConnector
Harness v0.1.2 published on Friday, Jul 19, 2024 by Pulumi

harness.platform.JenkinsConnector

Explore with Pulumi AI

harness logo
Harness v0.1.2 published on Friday, Jul 19, 2024 by Pulumi

    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>
    

    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.
    JenkinsUrl string
    Jenkins Url.
    Auth JenkinsConnectorAuth
    This entity contains the details for Jenkins Authentication.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    Identifier string
    Unique identifier of the resource.
    JenkinsUrl string
    Jenkins Url.
    Auth JenkinsConnectorAuthArgs
    This entity contains the details for Jenkins Authentication.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    identifier String
    Unique identifier of the resource.
    jenkinsUrl String
    Jenkins Url.
    auth JenkinsConnectorAuth
    This entity contains the details for Jenkins Authentication.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    identifier string
    Unique identifier of the resource.
    jenkinsUrl string
    Jenkins Url.
    auth JenkinsConnectorAuth
    This entity contains the details for Jenkins Authentication.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    identifier str
    Unique identifier of the resource.
    jenkins_url str
    Jenkins Url.
    auth JenkinsConnectorAuthArgs
    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.
    tags Sequence[str]
    Tags to associate with the resource.
    identifier String
    Unique identifier of the resource.
    jenkinsUrl String
    Jenkins Url.
    auth Property Map
    This entity contains the details for Jenkins Authentication.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.

    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.
    The following state arguments are supported:
    Auth JenkinsConnectorAuth
    This entity contains the details for Jenkins Authentication.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Identifier string
    Unique identifier of the resource.
    JenkinsUrl string
    Jenkins Url.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    Auth JenkinsConnectorAuthArgs
    This entity contains the details for Jenkins Authentication.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Identifier string
    Unique identifier of the resource.
    JenkinsUrl string
    Jenkins Url.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    auth JenkinsConnectorAuth
    This entity contains the details for Jenkins Authentication.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    identifier String
    Unique identifier of the resource.
    jenkinsUrl String
    Jenkins Url.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    auth JenkinsConnectorAuth
    This entity contains the details for Jenkins Authentication.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    identifier string
    Unique identifier of the resource.
    jenkinsUrl string
    Jenkins Url.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    auth JenkinsConnectorAuthArgs
    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.
    tags Sequence[str]
    Tags to associate with the resource.
    auth Property Map
    This entity contains the details for Jenkins Authentication.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    identifier String
    Unique identifier of the resource.
    jenkinsUrl String
    Jenkins Url.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.

    Supporting Types

    JenkinsConnectorAuth, JenkinsConnectorAuthArgs

    Type string
    Can be one of UsernamePassword, Anonymous, Bearer Token(HTTP Header)
    JenkinsBearerToken JenkinsConnectorAuthJenkinsBearerToken
    Authenticate to App Dynamics using bearer token.
    JenkinsUserNamePassword JenkinsConnectorAuthJenkinsUserNamePassword
    Authenticate to App Dynamics using user name and password.
    Type string
    Can be one of UsernamePassword, Anonymous, Bearer Token(HTTP Header)
    JenkinsBearerToken JenkinsConnectorAuthJenkinsBearerToken
    Authenticate to App Dynamics using bearer token.
    JenkinsUserNamePassword JenkinsConnectorAuthJenkinsUserNamePassword
    Authenticate to App Dynamics using user name and password.
    type String
    Can be one of UsernamePassword, Anonymous, Bearer Token(HTTP Header)
    jenkinsBearerToken JenkinsConnectorAuthJenkinsBearerToken
    Authenticate to App Dynamics using bearer token.
    jenkinsUserNamePassword JenkinsConnectorAuthJenkinsUserNamePassword
    Authenticate to App Dynamics using user name and password.
    type string
    Can be one of UsernamePassword, Anonymous, Bearer Token(HTTP Header)
    jenkinsBearerToken JenkinsConnectorAuthJenkinsBearerToken
    Authenticate to App Dynamics using bearer token.
    jenkinsUserNamePassword JenkinsConnectorAuthJenkinsUserNamePassword
    Authenticate to App Dynamics using user name and password.
    type str
    Can be one of UsernamePassword, Anonymous, Bearer Token(HTTP Header)
    jenkins_bearer_token JenkinsConnectorAuthJenkinsBearerToken
    Authenticate to App Dynamics using bearer token.
    jenkins_user_name_password JenkinsConnectorAuthJenkinsUserNamePassword
    Authenticate to App Dynamics using user name and password.
    type String
    Can be one of UsernamePassword, Anonymous, Bearer Token(HTTP Header)
    jenkinsBearerToken Property Map
    Authenticate to App Dynamics using bearer token.
    jenkinsUserNamePassword Property Map
    Authenticate to App Dynamics using user name and password.

    JenkinsConnectorAuthJenkinsBearerToken, JenkinsConnectorAuthJenkinsBearerTokenArgs

    TokenRef string
    Reference of the token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    TokenRef string
    Reference of the token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    tokenRef String
    Reference of the token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    tokenRef string
    Reference of the token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    token_ref str
    Reference of the token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    tokenRef String
    Reference of the token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    JenkinsConnectorAuthJenkinsUserNamePassword, JenkinsConnectorAuthJenkinsUserNamePasswordArgs

    PasswordRef string
    Reference to a secret containing the password to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.To reference a secret at the project scope, use directly without any prefix.
    Username string
    Username to use for authentication.
    UsernameRef string
    Username reference to use for authentication.
    PasswordRef string
    Reference to a secret containing the password to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.To reference a secret at the project scope, use directly without any prefix.
    Username string
    Username to use for authentication.
    UsernameRef string
    Username reference to use for authentication.
    passwordRef String
    Reference to a secret containing the password to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.To reference a secret at the project scope, use directly without any prefix.
    username String
    Username to use for authentication.
    usernameRef String
    Username reference to use for authentication.
    passwordRef string
    Reference to a secret containing the password to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.To reference a secret at the project scope, use directly without any prefix.
    username string
    Username to use for authentication.
    usernameRef string
    Username reference to use for authentication.
    password_ref str
    Reference to a secret containing the password to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.To reference a secret at the project scope, use directly without any prefix.
    username str
    Username to use for authentication.
    username_ref str
    Username reference to use for authentication.
    passwordRef String
    Reference to a secret containing the password to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.To reference a secret at the project scope, use directly without any prefix.
    username String
    Username to use for authentication.
    usernameRef String
    Username reference to use for authentication.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.1.2 published on Friday, Jul 19, 2024 by Pulumi