CodePipeline

class aws_cdk.aws_events_targets.CodePipeline(pipeline, *, event_role=None, dead_letter_queue=None, max_event_age=None, retry_attempts=None)

Bases: object

Allows the pipeline to be used as an EventBridge rule target.

ExampleMetadata:

infused

Example:

# A pipeline being used as a target for a CloudWatch event rule.
import aws_cdk.aws_events_targets as targets
import aws_cdk.aws_events as events

# pipeline: codepipeline.Pipeline


# kick off the pipeline every day
rule = events.Rule(self, "Daily",
    schedule=events.Schedule.rate(Duration.days(1))
)
rule.add_target(targets.CodePipeline(pipeline))
Parameters:

  • pipeline (IPipeline) –

  • event_role (Optional[IRole]) – The role to assume before invoking the target (i.e., the pipeline) when the given rule is triggered. Default: - a new role will be created

  • dead_letter_queue (Optional[IQueue]) – The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue. The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue. Default: - no dead-letter queue

  • max_event_age (Optional[Duration]) – The maximum age of a request that Lambda sends to a function for processing. Minimum value of 60. Maximum value of 86400. Default: Duration.hours(24)

  • retry_attempts (Union[int, float, None]) – The maximum number of times to retry when the function returns an error. Minimum value of 0. Maximum value of 185. Default: 185

Methods

bind(_rule, _id=None)

Returns the rule target specification.

NOTE: Do not use the various inputXxx options. They can be set in a call to addTarget.

Parameters:

  • _rule (IRule) –

  • _id (Optional[str]) –

Return type:

RuleTargetConfig