CodePipelineTargetOptions
- class aws_cdk.aws_events_targets.CodePipelineTargetOptions(*, dead_letter_queue=None, max_event_age=None, retry_attempts=None, event_role=None)
Bases:
TargetBaseProps
Customization options when creating a {@link CodePipeline} event target.
- Parameters:
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 queuemax_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: 185event_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
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_events_targets as events_targets import aws_cdk.aws_iam as iam import aws_cdk.aws_sqs as sqs import aws_cdk.core as cdk # queue: sqs.Queue # role: iam.Role code_pipeline_target_options = events_targets.CodePipelineTargetOptions( dead_letter_queue=queue, event_role=role, max_event_age=cdk.Duration.minutes(30), retry_attempts=123 )
Attributes
- dead_letter_queue
//docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations>`_.
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
- Type:
The SQS queue to be used as deadLetterQueue. Check out the `considerations for using a dead-letter queue <https
- event_role
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
- max_event_age
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
The maximum number of times to retry when the function returns an error.
Minimum value of 0. Maximum value of 185.
- Default:
185