IPipeline¶
-
class
aws_cdk.aws_codepipeline.
IPipeline
(*args, **kwds)¶ Bases:
aws_cdk.core.IResource
,typing_extensions.Protocol
The abstract view of an AWS CodePipeline as required and used by Actions.
It extends {@link events.IRuleTarget}, so this interface can be used as a Target for CloudWatch Events.
Methods
-
on_event
(id, *, description=None, event_pattern=None, rule_name=None, target=None)¶ Define an event rule triggered by this CodePipeline.
- Parameters
id (
str
) – Identifier for this event handler.description (
Optional
[str
]) – A description of the rule’s purpose. Default: - No descriptionevent_pattern (
Optional
[EventPattern
]) – 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.target (
Optional
[IRuleTarget
]) – The target to register for the event. Default: - No target is added to the rule. UseaddTarget()
to add a target.
- Return type
-
on_state_change
(id, *, description=None, event_pattern=None, rule_name=None, target=None)¶ Define an event rule triggered by the “CodePipeline Pipeline Execution State Change” event emitted from this pipeline.
- Parameters
id (
str
) – Identifier for this event handler.description (
Optional
[str
]) – A description of the rule’s purpose. Default: - No descriptionevent_pattern (
Optional
[EventPattern
]) – 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.target (
Optional
[IRuleTarget
]) – The target to register for the event. Default: - No target is added to the rule. UseaddTarget()
to add a target.
- Return type
Attributes
-
env
¶ The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- Return type
-
node
¶ The construct tree node for this construct.
- Return type
-
pipeline_arn
¶ The ARN of the Pipeline.
- Attribute
true
- Return type
str
-
pipeline_name
¶ The name of the Pipeline.
- Attribute
true
- Return type
str
-