JenkinsActionProps

class aws_cdk.aws_codepipeline_actions.JenkinsActionProps(*, action_name, run_order=None, variables_namespace=None, jenkins_provider, project_name, type, inputs=None, outputs=None)

Bases: CommonActionProps

Construction properties of {@link JenkinsAction}.

Parameters:

  • action_name (str) – The physical, human-readable name of the Action. Note that Action names must be unique within a single Stage.

  • run_order (Union[int, float, None]) – The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute. Default: 1

  • variables_namespace (Optional[str]) – The name of the namespace to use for variables emitted by this action. 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

  • jenkins_provider (IJenkinsProvider) – The Jenkins Provider for this Action.

  • project_name (str) – 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 (Optional[Sequence[Artifact]]) – The source to use as input for this build.

  • outputs (Optional[Sequence[Artifact]]) –

ExampleMetadata:

infused

Example:

# 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
)

Attributes

action_name

The physical, human-readable name of the Action.

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

inputs

The source to use as input for this build.

jenkins_provider

The Jenkins Provider for this Action.

outputs
project_name

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

Example:

"MyJob"
run_order

The runOrder property for this Action.

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

Default:

1

See:

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

type

The type of the Action - Build, or Test.

variables_namespace

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

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