1.204.0

interface CodeBuildProjectProps

LanguageType name
.NETAmazon.CDK.AWS.Events.Targets.CodeBuildProjectProps
Javasoftware.amazon.awscdk.services.events.targets.CodeBuildProjectProps
Pythonaws_cdk.aws_events_targets.CodeBuildProjectProps
TypeScript (source)@aws-cdk/aws-events-targets » CodeBuildProjectProps

Customize the CodeBuild Event Target.

Example

import * as codebuild from '@aws-cdk/aws-codebuild';
import * as codecommit from '@aws-cdk/aws-codecommit';

const repo = new codecommit.Repository(this, 'MyRepo', {
  repositoryName: 'aws-cdk-codebuild-events',
});

const project = new codebuild.Project(this, 'MyProject', {
  source: codebuild.Source.codeCommit({ repository: repo }),
});

const deadLetterQueue = new sqs.Queue(this, 'DeadLetterQueue');

// trigger a build when a commit is pushed to the repo
const onCommitRule = repo.onCommit('OnCommit', {
  target: new targets.CodeBuildProject(project, {
    deadLetterQueue: deadLetterQueue,
  }),
  branches: ['master'],
});

Properties

NameTypeDescription
deadLetterQueue?IQueueThe SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue.
event?RuleTargetInputThe event to send to CodeBuild.
eventRole?IRoleThe role to assume before invoking the target (i.e., the codebuild) when the given rule is triggered.
maxEventAge?DurationThe maximum age of a request that Lambda sends to a function for processing.
retryAttempts?numberThe maximum number of times to retry when the function returns an error.

deadLetterQueue?

Type: IQueue (optional, default: no dead-letter queue)

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.

event?

Type: RuleTargetInput (optional, default: the entire EventBridge event)

The event to send to CodeBuild.

This will be the payload for the StartBuild API.

eventRole?

Type: IRole (optional, default: a new role will be created)

The role to assume before invoking the target (i.e., the codebuild) when the given rule is triggered.

maxEventAge?

Type: Duration (optional, default: Duration.hours(24))

The maximum age of a request that Lambda sends to a function for processing.

Minimum value of 60. Maximum value of 86400.

retryAttempts?

Type: number (optional, default: 185)

The maximum number of times to retry when the function returns an error.

Minimum value of 0. Maximum value of 185.

← PreviousNext →