IStage¶
-
class
aws_cdk.aws_codepipeline.
IStage
(*args, **kwds)¶ Bases:
typing_extensions.Protocol
The abstract interface of a Pipeline Stage that is used by Actions.
Methods
-
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: trueevent_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
[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
-
stage_name
¶ The physical, human-readable name of this Pipeline Stage.
- Return type
str
-