class JenkinsProvider (construct)

Language	Type name
.NET	Amazon.CDK.AWS.CodePipeline.Actions.JenkinsProvider
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscodepipelineactions#JenkinsProvider
Java	software.amazon.awscdk.services.codepipeline.actions.JenkinsProvider
Python	aws_cdk.aws_codepipeline_actions.JenkinsProvider
TypeScript (source)	aws-cdk-lib » aws_codepipeline_actions » JenkinsProvider

Implements IConstruct, IDependable, IJenkinsProvider

A class representing Jenkins providers.

See also: #import

Example

const jenkinsProvider = new codepipeline_actions.JenkinsProvider(this, 'JenkinsProvider', {
  providerName: 'MyJenkinsProvider',
  serverUrl: 'http://my-jenkins.com:8080',
  version: '2', // optional, default: '1'
});

Initializer

new JenkinsProvider(scope: Construct, id: string, props: JenkinsProviderProps)

Parameters

• scope Construct
• id string
• props JenkinsProviderProps

Construct Props

Name	Type	Description
providerName	string	The name of the Jenkins provider that you set in the AWS CodePipeline plugin configuration of your Jenkins project.
serverUrl	string	The base URL of your Jenkins server.
forBuild?	boolean	Whether to immediately register a Jenkins Provider for the build category.
forTest?	boolean	Whether to immediately register a Jenkins Provider for the test category.
version?	string	The version of your provider.

---

providerName

Type: string

The name of the Jenkins provider that you set in the AWS CodePipeline plugin configuration of your Jenkins project. Example

'MyJenkinsProvider'

---

serverUrl

Type: string

The base URL of your Jenkins server. Example

'http://myjenkins.com:8080'

---

forBuild?

Type: boolean (optional, default: false)

Whether to immediately register a Jenkins Provider for the build category.

The Provider will always be registered if you create a JenkinsAction.

---

forTest?

Type: boolean (optional, default: false)

Whether to immediately register a Jenkins Provider for the test category.

The Provider will always be registered if you create a JenkinsTestAction.

---

version?

Type: string (optional, default: '1')

The version of your provider.

Properties

Name	Type	Description
node	Node	The tree node.
providerName	string
serverUrl	string
version	string

---

node

Type: Node

The tree node.

---

providerName

Type: string

---

serverUrl

Type: string

---

version

Type: string

Methods

Name	Description
toString()	Returns a string representation of this construct.
with(...mixins)	Applies one or more mixins to this construct.
static fromJenkinsProviderAttributes(scope, id, attrs)	Import a Jenkins provider registered either outside the CDK, or in a different CDK Stack.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

with(...mixins)

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin — The mixins to apply.

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

---

static fromJenkinsProviderAttributes(scope, id, attrs)

public static fromJenkinsProviderAttributes(scope: Construct, id: string, attrs: JenkinsProviderAttributes): IJenkinsProvider

Parameters

• scope Construct — the parent Construct for the new provider.
• id string — the identifier of the new provider Construct.
• attrs JenkinsProviderAttributes — the properties used to identify the existing provider.

Returns

• IJenkinsProvider

Import a Jenkins provider registered either outside the CDK, or in a different CDK Stack.