JenkinsAction

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

Bases: aws_cdk.aws_codepipeline_actions.Action

Jenkins build CodePipeline Action.

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

__init__(*, jenkins_provider, project_name, type, inputs=None, outputs=None, action_name, run_order=None, variables_namespace=None)
Parameters
  • 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[List[Artifact]]) – The source to use as input for this build.

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

  • 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

Return type

None

Methods

bind(scope, stage, *, bucket, role)
Parameters

stability :stability: experimental

Return type

ActionConfig

on_state_change(name, target=None, *, description=None, enabled=None, event_bus=None, event_pattern=None, rule_name=None, schedule=None, targets=None)
Parameters
  • name (str) –

  • target (Optional[IRuleTarget]) –

  • description (Optional[str]) – A description of the rule’s purpose. Default: - No description.

  • enabled (Optional[bool]) – Indicates whether the rule is enabled. Default: true

  • event_bus (Optional[IEventBus]) – The event bus to associate with this rule. Default: - The default event bus.

  • event_pattern (Optional[EventPattern]) – Describes which events EventBridge routes to the specified target. These routed events are matched events. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide. Default: - None.

  • rule_name (Optional[str]) – A name for the rule. Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.

  • schedule (Optional[Schedule]) – The schedule or rate (frequency) that determines when EventBridge runs the rule. For more information, see Schedule Expression Syntax for Rules in the Amazon EventBridge User Guide. Default: - None.

  • targets (Optional[List[IRuleTarget]]) – Targets to invoke when this rule matches an event. Input will be the full matched event. If you wish to specify custom target input, use addTarget(target[, inputOptions]). Default: - No targets.

stability :stability: experimental

Return type

Rule

Attributes

action_properties

stability :stability: experimental

Return type

ActionProperties