Action
- class aws_cdk.aws_codepipeline.Action
Bases:
objectLow-level class for generic CodePipeline Actions implementing the {@link IAction} interface.
Contains some common logic that can be re-used by all {@link IAction} implementations. If you’re writing your own Action class, feel free to extend this class.
Methods
- bind(scope, stage, *, bucket, role)
The callback invoked when this Action is added to a Pipeline.
- Parameters
- Return type
- on_state_change(name, target=None, *, description=None, enabled=None, event_bus=None, event_pattern=None, rule_name=None, schedule=None, targets=None)
Creates an Event that will be triggered whenever the state of this Action changes.
- 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: trueevent_bus (
Optional[IEventBus]) – The event bus to associate with this rule. Default: - The default event bus.event_pattern (
Union[EventPattern,Dict[str,Any],None]) – 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[Sequence[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, useaddTarget(target[, inputOptions]). Default: - No targets.
- Return type
Attributes