AWS CDK Reference

Appearance

v2.273.0

JenkinsAction Class ​

Jenkins build CodePipeline Action.

Source
aws-codepipeline-actions/lib/jenkins/jenkins-action.ts

Example ​

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

build_action = codepipeline_actions.JenkinsAction(
    action_name="JenkinsBuild",
    jenkins_provider=jenkins_provider,
    project_name="MyProject",
    type=codepipeline_actions.JenkinsActionType.BUILD
)
java
JenkinsProvider jenkinsProvider;

JenkinsAction buildAction = JenkinsAction.Builder.create()
        .actionName("JenkinsBuild")
        .jenkinsProvider(jenkinsProvider)
        .projectName("MyProject")
        .type(JenkinsActionType.BUILD)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
JenkinsProvider jenkinsProvider;

var buildAction = new JenkinsAction(new JenkinsActionProps {
    ActionName = "JenkinsBuild",
    JenkinsProvider = jenkinsProvider,
    ProjectName = "MyProject",
    Type = JenkinsActionType.BUILD
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var jenkinsProvider JenkinsProvider

buildAction := codepipeline_actions.NewJenkinsAction(&JenkinsActionProps{
	ActionName: jsii.String("JenkinsBuild"),
	JenkinsProvider: jenkinsProvider,
	ProjectName: jsii.String("MyProject"),
	Type: codepipeline_actions.JenkinsActionType_BUILD,
})

Initializer ​

ts
new JenkinsAction(props: JenkinsActionProps)
python
JenkinsAction(props: JenkinsActionProps)
java
new JenkinsAction(JenkinsActionProps props)
csharp
new JenkinsAction(JenkinsActionProps props)
go
NewJenkinsAction(Props JenkinsActionProps)

Properties ​

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

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

Methods ​

bind(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfigdef bind(self, scope: Construct, stage: IStage, options: ActionBindOptions) -> ActionConfigpublic ActionConfig bind(Construct scope, IStage stage, ActionBindOptions options)public ActionConfig Bind(Construct scope, IStage stage, ActionBindOptions options)func Bind(Scope Construct, Stage IStage, Options ActionBindOptions) ActionConfig#
The callback invoked when this Action is added to a Pipeline.
onStateChange(name: string, target?: IRuleTarget, options?: RuleProps): Ruledef on_state_change(self, name: str, target: typing.Optional[IRuleTarget] = None, options: typing.Optional[RuleProps] = None) -> Rulepublic Rule onStateChange(String name, IRuleTarget target, RuleProps options)public Rule OnStateChange(string name, IRuleTarget? target = null, RuleProps? options = null)func OnStateChange(Name *string, Target IRuleTarget, Options RuleProps) Rule#
Creates an Event that will be triggered whenever the state of this Action changes.