interface JenkinsActionProps

Language	Type name
.NET	Amazon.CDK.AWS.CodePipeline.Actions.JenkinsActionProps
Java	software.amazon.awscdk.services.codepipeline.actions.JenkinsActionProps
Python	aws_cdk.aws_codepipeline_actions.JenkinsActionProps
TypeScript (source)	@aws-cdk/aws-codepipeline-actions » JenkinsActionProps

Construction properties of {@link JenkinsAction}.

Example

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

Properties

Name	Type	Description
actionName	string	The physical, human-readable name of the Action.
jenkinsProvider	IJenkinsProvider	The Jenkins Provider for this Action.
projectName	string	The name of the project (sometimes also called job, or task) on your Jenkins installation that will be invoked by this Action.
type	JenkinsActionType	The type of the Action - Build, or Test.
inputs?	Artifact[]	The source to use as input for this build.
outputs?	Artifact[]
runOrder?	number	The runOrder property for this Action.
variablesNamespace?	string	The name of the namespace to use for variables emitted by this action.

---

actionName

Type: string

The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

---

jenkinsProvider

Type: IJenkinsProvider

The Jenkins Provider for this Action.

---

projectName

Type: string

The name of the project (sometimes also called job, or task) on your Jenkins installation that will be invoked by this Action. Example

'MyJob'

---

type

Type: JenkinsActionType

The type of the Action - Build, or Test.

---

inputs?

Type: Artifact[] (optional)

The source to use as input for this build.

---

outputs?

Type: Artifact[] (optional)

---

runOrder?

Type: number (optional, default: 1)

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

See also: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html

---

variablesNamespace?

Type: string (optional, default: a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set)

The name of the namespace to use for variables emitted by this action.