Package software.amazon.awscdk.services.scheduler.targets.alpha

Class CodePipelineStartPipelineExecution.Builder

java.lang.Object

software.amazon.awscdk.services.scheduler.targets.alpha.CodePipelineStartPipelineExecution.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CodePipelineStartPipelineExecution>

Enclosing class:

CodePipelineStartPipelineExecution

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

(experimental) A fluent builder for CodePipelineStartPipelineExecution.

Method Summary

Modifier and Type	Method	Description
CodePipelineStartPipelineExecution	build()
static CodePipelineStartPipelineExecution.Builder	create(IPipeline pipeline)
CodePipelineStartPipelineExecution.Builder	deadLetterQueue(IQueue deadLetterQueue)	(experimental) The SQS queue to be used as deadLetterQueue.
CodePipelineStartPipelineExecution.Builder	input(ScheduleTargetInput input)	(experimental) Input passed to the target.
CodePipelineStartPipelineExecution.Builder	maxEventAge(Duration maxEventAge)	(experimental) The maximum age of a request that Scheduler sends to a target for processing.
CodePipelineStartPipelineExecution.Builder	retryAttempts(Number retryAttempts)	(experimental) The maximum number of times to retry when the target returns an error.
CodePipelineStartPipelineExecution.Builder	role(IRole role)	(experimental) An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Experimental)
public static CodePipelineStartPipelineExecution.Builder create(IPipeline pipeline)

Parameters:

pipeline - This parameter is required.

Returns:

a new instance of CodePipelineStartPipelineExecution.Builder.

deadLetterQueue

@Stability(Experimental)
public CodePipelineStartPipelineExecution.Builder deadLetterQueue(IQueue deadLetterQueue)

(experimental) The SQS queue to be used as deadLetterQueue.

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. This parameter is required.

Returns:

this

input

@Stability(Experimental)
public CodePipelineStartPipelineExecution.Builder input(ScheduleTargetInput input)

(experimental) Input passed to the target.

Default: - no input.

Parameters:

input - Input passed to the target. This parameter is required.

Returns:

this

maxEventAge

@Stability(Experimental)
public CodePipelineStartPipelineExecution.Builder maxEventAge(Duration maxEventAge)

(experimental) The maximum age of a request that Scheduler sends to a target for processing.

Minimum value of 60. Maximum value of 86400.

Default: Duration.hours(24)

Parameters:

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

Returns:

this

retryAttempts

@Stability(Experimental)
public CodePipelineStartPipelineExecution.Builder retryAttempts(Number retryAttempts)

(experimental) The maximum number of times to retry when the target returns an error.

Minimum value of 0. Maximum value of 185.

Default: 185

Parameters:

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

Returns:

this

role

@Stability(Experimental)
public CodePipelineStartPipelineExecution.Builder role(IRole role)

(experimental) An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf.

If none provided templates target will automatically create an IAM role with all the minimum necessary permissions to interact with the templated target. If you wish you may specify your own IAM role, then the templated targets will grant minimal required permissions.

Universal target automatically create an IAM role if you do not specify your own IAM role. However, in comparison with templated targets, for universal targets you must grant the required IAM permissions yourself.

Default: - created by target

Parameters:

role - An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public CodePipelineStartPipelineExecution build()

Specified by:

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

Returns:

a newly built instance of CodePipelineStartPipelineExecution.