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

Class ScheduleTargetConfig.Builder

java.lang.Object

software.amazon.awscdk.services.scheduler.alpha.ScheduleTargetConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ScheduleTargetConfig>

Enclosing interface:

ScheduleTargetConfig

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

A builder for ScheduleTargetConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ScheduleTargetConfig.Builder	arn(String arn)	Sets the value of ScheduleTargetConfig.getArn()
ScheduleTargetConfig	build()	Builds the configured instance.
ScheduleTargetConfig.Builder	deadLetterConfig(CfnSchedule.DeadLetterConfigProperty deadLetterConfig)	Sets the value of ScheduleTargetConfig.getDeadLetterConfig()
ScheduleTargetConfig.Builder	ecsParameters(CfnSchedule.EcsParametersProperty ecsParameters)	Sets the value of ScheduleTargetConfig.getEcsParameters()
ScheduleTargetConfig.Builder	eventBridgeParameters(CfnSchedule.EventBridgeParametersProperty eventBridgeParameters)	Sets the value of ScheduleTargetConfig.getEventBridgeParameters()
ScheduleTargetConfig.Builder	input(ScheduleTargetInput input)	Sets the value of ScheduleTargetConfig.getInput()
ScheduleTargetConfig.Builder	kinesisParameters(CfnSchedule.KinesisParametersProperty kinesisParameters)	Sets the value of ScheduleTargetConfig.getKinesisParameters()
ScheduleTargetConfig.Builder	retryPolicy(CfnSchedule.RetryPolicyProperty retryPolicy)	Sets the value of ScheduleTargetConfig.getRetryPolicy()
ScheduleTargetConfig.Builder	role(IRole role)	Sets the value of ScheduleTargetConfig.getRole()
ScheduleTargetConfig.Builder	sageMakerPipelineParameters(CfnSchedule.SageMakerPipelineParametersProperty sageMakerPipelineParameters)	Sets the value of ScheduleTargetConfig.getSageMakerPipelineParameters()
ScheduleTargetConfig.Builder	sqsParameters(CfnSchedule.SqsParametersProperty sqsParameters)	Sets the value of ScheduleTargetConfig.getSqsParameters()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

arn

@Stability(Experimental)
public ScheduleTargetConfig.Builder arn(String arn)

Sets the value of ScheduleTargetConfig.getArn()

Parameters:

arn - The Amazon Resource Name (ARN) of the target. This parameter is required.

Returns:

this

role

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

Sets the value of ScheduleTargetConfig.getRole()

Parameters:

role - Role to use to invoke this event target. This parameter is required.

Returns:

this

deadLetterConfig

@Stability(Experimental)
public ScheduleTargetConfig.Builder deadLetterConfig(CfnSchedule.DeadLetterConfigProperty deadLetterConfig)

Sets the value of ScheduleTargetConfig.getDeadLetterConfig()

Parameters:

deadLetterConfig - An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.\

Returns:

this

ecsParameters

@Stability(Experimental)
public ScheduleTargetConfig.Builder ecsParameters(CfnSchedule.EcsParametersProperty ecsParameters)

Sets the value of ScheduleTargetConfig.getEcsParameters()

Parameters:

ecsParameters - The templated target type for the Amazon ECS RunTask API Operation.

Returns:

this

eventBridgeParameters

@Stability(Experimental)
public ScheduleTargetConfig.Builder eventBridgeParameters(CfnSchedule.EventBridgeParametersProperty eventBridgeParameters)

Sets the value of ScheduleTargetConfig.getEventBridgeParameters()

Parameters:

eventBridgeParameters - The templated target type for the EventBridge PutEvents API operation.

Returns:

this

input

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

Sets the value of ScheduleTargetConfig.getInput()

Parameters:

input - What input to pass to the target.

Returns:

this

kinesisParameters

@Stability(Experimental)
public ScheduleTargetConfig.Builder kinesisParameters(CfnSchedule.KinesisParametersProperty kinesisParameters)

Sets the value of ScheduleTargetConfig.getKinesisParameters()

Parameters:

kinesisParameters - The templated target type for the Amazon Kinesis PutRecord API operation.

Returns:

this

retryPolicy

@Stability(Experimental)
public ScheduleTargetConfig.Builder retryPolicy(CfnSchedule.RetryPolicyProperty retryPolicy)

Sets the value of ScheduleTargetConfig.getRetryPolicy()

Parameters:

retryPolicy - A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.

Returns:

this

sageMakerPipelineParameters

@Stability(Experimental)
public ScheduleTargetConfig.Builder sageMakerPipelineParameters(CfnSchedule.SageMakerPipelineParametersProperty sageMakerPipelineParameters)

Sets the value of ScheduleTargetConfig.getSageMakerPipelineParameters()

Parameters:

sageMakerPipelineParameters - The templated target type for the Amazon SageMaker StartPipelineExecution API operation.

Returns:

this

sqsParameters

@Stability(Experimental)
public ScheduleTargetConfig.Builder sqsParameters(CfnSchedule.SqsParametersProperty sqsParameters)

Sets the value of ScheduleTargetConfig.getSqsParameters()

Parameters:

sqsParameters - The templated target type for the Amazon SQS SendMessage API Operation.

Returns:

this

build

@Stability(Experimental)
public ScheduleTargetConfig build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ScheduleTargetConfig

Throws:

NullPointerException - if any required attribute was not provided