IStage
- class aws_cdk.aws_codepipeline.IStage(*args, **kwargs)
Bases:
Protocol
The abstract interface of a Pipeline Stage that is used by Actions.
Methods
- on_state_change(name, target=None, *, enabled=None, event_bus=None, schedule=None, targets=None, cross_stack_scope=None, description=None, event_pattern=None, rule_name=None)
- Parameters:
name (
str
) –target (
Optional
[IRuleTarget
]) –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.schedule (
Optional
[Schedule
]) – The schedule or rate (frequency) that determines when EventBridge runs the rule. You must specify this property, theeventPattern
property, or both. 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.cross_stack_scope (
Optional
[Construct
]) – The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region). This helps dealing with cycles that often arise in these situations. Default: - none (the main scope will be used, even for cross-stack Events)description (
Optional
[str
]) – A description of the rule’s purpose. Default: - No descriptionevent_pattern (
Union
[EventPattern
,Dict
[str
,Any
],None
]) – Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. Default: - No additional filtering based on an event pattern.rule_name (
Optional
[str
]) – A name for the rule. Default: AWS CloudFormation generates a unique physical ID.
- Return type:
Attributes
- actions
The actions belonging to this stage.
- pipeline
- stage_name
The physical, human-readable name of this Pipeline Stage.