Package software.amazon.awscdk.services.events.targets

Class CodePipeline.Builder

java.lang.Object

software.amazon.awscdk.services.events.targets.CodePipeline.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CodePipeline>

Enclosing class:

CodePipeline

@Stability(Stable)
public static final class CodePipeline.Builder
extends Object
implements software.amazon.jsii.Builder<CodePipeline>

A fluent builder for CodePipeline.

Method Summary

Modifier and Type	Method	Description
CodePipeline	build()
static CodePipeline.Builder	create(IPipeline pipeline)
CodePipeline.Builder	deadLetterQueue(IQueue deadLetterQueue)	The SQS queue to be used as deadLetterQueue.
CodePipeline.Builder	eventRole(IRole eventRole)	The role to assume before invoking the target (i.e., the pipeline) when the given rule is triggered.
CodePipeline.Builder	maxEventAge(Duration maxEventAge)	The maximum age of a request that Lambda sends to a function for processing.
CodePipeline.Builder	retryAttempts(Number retryAttempts)	The maximum number of times to retry when the function returns an error.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CodePipeline.Builder create(IPipeline pipeline)

Parameters:

pipeline - This parameter is required.

Returns:

a new instance of CodePipeline.Builder.

deadLetterQueue

@Stability(Stable)
public CodePipeline.Builder deadLetterQueue(IQueue deadLetterQueue)

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

Parameters:

deadLetterQueue - The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue. This parameter is required.

Returns:

this

maxEventAge

@Stability(Stable)
public CodePipeline.Builder maxEventAge(Duration maxEventAge)

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)

Parameters:

maxEventAge - The maximum age of a request that Lambda sends to a function for processing. This parameter is required.

Returns:

this

retryAttempts

@Stability(Stable)
public CodePipeline.Builder retryAttempts(Number retryAttempts)

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

Minimum value of 0. Maximum value of 185.

Default: 185

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. This parameter is required.

Returns:

this

eventRole

@Stability(Stable)
public CodePipeline.Builder eventRole(IRole eventRole)

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

Parameters:

eventRole - The role to assume before invoking the target (i.e., the pipeline) when the given rule is triggered. This parameter is required.

Returns:

this

build

@Stability(Stable)
public CodePipeline build()

Specified by:

build in interface software.amazon.jsii.Builder<CodePipeline>

Returns:

a newly built instance of CodePipeline.