software.amazon.awscdk.services.events.targets

Class CodePipelineTargetOptions.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CodePipelineTargetOptions>

Enclosing interface:

CodePipelineTargetOptions

@Stability(value=Experimental)
public static final class CodePipelineTargetOptions.Builder
extends Object
implements software.amazon.jsii.Builder<CodePipelineTargetOptions>

A builder for CodePipelineTargetOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CodePipelineTargetOptions	build() Builds the configured instance.
CodePipelineTargetOptions.Builder	deadLetterQueue(IQueue deadLetterQueue) Sets the value of TargetBaseProps.getDeadLetterQueue()
CodePipelineTargetOptions.Builder	eventRole(IRole eventRole) Sets the value of CodePipelineTargetOptions.getEventRole()
CodePipelineTargetOptions.Builder	maxEventAge(Duration maxEventAge) Sets the value of TargetBaseProps.getMaxEventAge()
CodePipelineTargetOptions.Builder	retryAttempts(Number retryAttempts) Sets the value of TargetBaseProps.getRetryAttempts()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

eventRole

@Stability(value=Experimental)
public CodePipelineTargetOptions.Builder eventRole(IRole eventRole)

Sets the value of CodePipelineTargetOptions.getEventRole()

Parameters:

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

Returns:

this

deadLetterQueue

@Stability(value=Experimental)
public CodePipelineTargetOptions.Builder deadLetterQueue(IQueue deadLetterQueue)

Sets the value of TargetBaseProps.getDeadLetterQueue()

Parameters:

deadLetterQueue - The SQS queue to be used as deadLetterQueue. Check out the [considerations for using a dead-letter queue](https://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.

Returns:

this

maxEventAge

@Stability(value=Experimental)
public CodePipelineTargetOptions.Builder maxEventAge(Duration maxEventAge)

Sets the value of TargetBaseProps.getMaxEventAge()

Parameters:

maxEventAge - The maximum age of a request that Lambda sends to a function for processing. Minimum value of 60. Maximum value of 86400.

Returns:

this

retryAttempts

@Stability(value=Experimental)
public CodePipelineTargetOptions.Builder retryAttempts(Number retryAttempts)

Sets the value of TargetBaseProps.getRetryAttempts()

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. Minimum value of 0. Maximum value of 185.

Returns:

this

build

@Stability(value=Experimental)
public CodePipelineTargetOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CodePipelineTargetOptions

Throws:

NullPointerException - if any required attribute was not provided