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

Class SageMakerStartPipelineExecution.Builder

java.lang.Object

software.amazon.awscdk.services.scheduler.targets.SageMakerStartPipelineExecution.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SageMakerStartPipelineExecution>

Enclosing class:

SageMakerStartPipelineExecution

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

A fluent builder for SageMakerStartPipelineExecution.

Method Summary

Modifier and Type	Method	Description
SageMakerStartPipelineExecution	build()
static SageMakerStartPipelineExecution.Builder	create(IPipeline pipeline)
SageMakerStartPipelineExecution.Builder	deadLetterQueue(IQueue deadLetterQueue)	The SQS queue to be used as deadLetterQueue.
SageMakerStartPipelineExecution.Builder	input(ScheduleTargetInput input)	Input passed to the target.
SageMakerStartPipelineExecution.Builder	maxEventAge(Duration maxEventAge)	The maximum age of a request that Scheduler sends to a target for processing.
SageMakerStartPipelineExecution.Builder	pipelineParameterList(List<? extends SageMakerPipelineParameter> pipelineParameterList)	List of parameter names and values to use when executing the SageMaker Model Building Pipeline.
SageMakerStartPipelineExecution.Builder	retryAttempts(Number retryAttempts)	The maximum number of times to retry when the target returns an error.
SageMakerStartPipelineExecution.Builder	role(IRole role)	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(Stable)
public static SageMakerStartPipelineExecution.Builder create(IPipeline pipeline)

Parameters:

pipeline - This parameter is required.

Returns:

a new instance of SageMakerStartPipelineExecution.Builder.

deadLetterQueue

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

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(Stable)
public SageMakerStartPipelineExecution.Builder input(ScheduleTargetInput input)

Input passed to the target.

Default: - no input.

Parameters:

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

Returns:

this

maxEventAge

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

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(Stable)
public SageMakerStartPipelineExecution.Builder retryAttempts(Number retryAttempts)

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(Stable)
public SageMakerStartPipelineExecution.Builder role(IRole role)

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.

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

pipelineParameterList

@Stability(Stable)
public SageMakerStartPipelineExecution.Builder pipelineParameterList(List<? extends SageMakerPipelineParameter> pipelineParameterList)

List of parameter names and values to use when executing the SageMaker Model Building Pipeline.

The length must be between 0 and 200.

Default: - no pipeline parameter list

Parameters:

pipelineParameterList - List of parameter names and values to use when executing the SageMaker Model Building Pipeline. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sagemakerpipelineparameters.html#cfn-scheduler-schedule-sagemakerpipelineparameters-pipelineparameterlist

build

@Stability(Stable)
public SageMakerStartPipelineExecution build()

Specified by:

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

Returns:

a newly built instance of SageMakerStartPipelineExecution.