class JenkinsAction
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.CodePipeline.Actions.JenkinsAction |
Java | software.amazon.awscdk.services.codepipeline.actions.JenkinsAction |
Python | aws_cdk.aws_codepipeline_actions.JenkinsAction |
TypeScript (source) | @aws-cdk/aws-codepipeline-actions » JenkinsAction |
Implements
IAction
Extends
Action
Jenkins build CodePipeline Action.
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
Jenkins
Action Props
Properties
Name | Type | Description |
---|---|---|
action | Action | The simple properties of the Action, like its Owner, name, etc. |
actionProperties
Type:
Action
The simple properties of the Action, like its Owner, name, etc.
Note that this accessor will be called before the {@link bind} callback.
Methods
Name | Description |
---|---|
bind(scope, stage, options) | The callback invoked when this Action is added to a Pipeline. |
on | 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 {@link IAction.bind} method. |
bind(scope, stage, options)
public bind(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfig
Parameters
- scope
Construct
- stage
IStage
- options
Action
Bind Options
Returns
The callback invoked when this Action is added to a Pipeline.
StateChange(name, target?, options?)
onpublic onStateChange(name: string, target?: IRuleTarget, options?: RuleProps): Rule
Parameters
- name
string
- target
IRule
Target - options
Rule
Props
Returns
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
Action
Bind Options
Returns
This is a renamed version of the {@link IAction.bind} method.