class JenkinsAction

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

Implements IAction

Extends Action

Jenkins build CodePipeline Action.

See also: https://docs.aws.amazon.com/codepipeline/latest/userguide/tutorials-four-stage-pipeline.html

Example

declare const jenkinsProvider: codepipeline_actions.JenkinsProvider;
const buildAction = new codepipeline_actions.JenkinsAction({
  actionName: 'JenkinsBuild',
  jenkinsProvider: jenkinsProvider,
  projectName: 'MyProject',
  type: codepipeline_actions.JenkinsActionType.BUILD,
});

Initializer

new JenkinsAction(props: JenkinsActionProps)

Parameters

• props JenkinsActionProps

Properties

Name	Type	Description
actionProperties	ActionProperties	The simple properties of the Action, like its Owner, name, etc.

---

actionProperties

Type: ActionProperties

The simple properties of the Action, like its Owner, name, etc.

Note that this accessor will be called before the bind callback.

Methods

Name	Description
bind(scope, stage, options)	The callback invoked when this Action is added to a Pipeline.
onStateChange(name, target?, options?)	Creates an Event that will be triggered whenever the state of this Action changes.
protected bound(_scope, _stage, _options)	This is a renamed version of the IAction.bind method.

---

bind(scope, stage, options)

public bind(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfig

Parameters

• scope Construct
• stage IStage
• options ActionBindOptions

Returns

• ActionConfig

The callback invoked when this Action is added to a Pipeline.

---

onStateChange(name, target?, options?)

public onStateChange(name: string, target?: IRuleTarget, options?: RuleProps): Rule

Parameters

• name string
• target IRuleTarget
• options RuleProps

Returns

• Rule

Creates an Event that will be triggered whenever the state of this Action changes.

---

protected bound(_scope, _stage, _options)

protected bound(_scope: Construct, _stage: IStage, _options: ActionBindOptions): ActionConfig

Parameters

• _scope Construct
• _stage IStage
• _options ActionBindOptions

Returns

• ActionConfig

This is a renamed version of the IAction.bind method.