CodeBuildProjectProps¶
-
class
aws_cdk.aws_events_targets.
CodeBuildProjectProps
(*, dead_letter_queue=None, max_event_age=None, retry_attempts=None, event=None, event_role=None)¶ Bases:
aws_cdk.aws_events_targets.TargetBaseProps
Customize the CodeBuild 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 (
Optional
[RuleTargetInput
]) – The event to send to CodeBuild. This will be the payload for the StartBuild API. Default: - the entire EventBridge eventevent_role (
Optional
[IRole
]) – The role to assume before invoking the target (i.e., the codebuild) when the given rule is triggered. Default: - a new role will be created
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.
-
event
¶ The event to send to CodeBuild.
This will be the payload for the StartBuild API.
- Default
the entire EventBridge event
- Return type
Optional
[RuleTargetInput
]
-
event_role
¶ The role to assume before invoking the target (i.e., the codebuild) when the given rule is triggered.
- Default
a new role will be created
- Return type
Optional
[IRole
]
-
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)
- Return type
Optional
[Duration
]
-
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
- Return type
Union
[int
,float
,None
]