Package software.amazon.awscdk.services.scheduler

Class CfnSchedule.TargetProperty.Builder

java.lang.Object

software.amazon.awscdk.services.scheduler.CfnSchedule.TargetProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSchedule.TargetProperty>

Enclosing interface:

CfnSchedule.TargetProperty

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

A builder for CfnSchedule.TargetProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnSchedule.TargetProperty.Builder	arn(String arn)	Sets the value of CfnSchedule.TargetProperty.getArn()
CfnSchedule.TargetProperty	build()	Builds the configured instance.
CfnSchedule.TargetProperty.Builder	deadLetterConfig(IResolvable deadLetterConfig)	Sets the value of CfnSchedule.TargetProperty.getDeadLetterConfig()
CfnSchedule.TargetProperty.Builder	deadLetterConfig(CfnSchedule.DeadLetterConfigProperty deadLetterConfig)	Sets the value of CfnSchedule.TargetProperty.getDeadLetterConfig()
CfnSchedule.TargetProperty.Builder	ecsParameters(IResolvable ecsParameters)	Sets the value of CfnSchedule.TargetProperty.getEcsParameters()
CfnSchedule.TargetProperty.Builder	ecsParameters(CfnSchedule.EcsParametersProperty ecsParameters)	Sets the value of CfnSchedule.TargetProperty.getEcsParameters()
CfnSchedule.TargetProperty.Builder	eventBridgeParameters(IResolvable eventBridgeParameters)	Sets the value of CfnSchedule.TargetProperty.getEventBridgeParameters()
CfnSchedule.TargetProperty.Builder	eventBridgeParameters(CfnSchedule.EventBridgeParametersProperty eventBridgeParameters)	Sets the value of CfnSchedule.TargetProperty.getEventBridgeParameters()
CfnSchedule.TargetProperty.Builder	input(String input)	Sets the value of CfnSchedule.TargetProperty.getInput()
CfnSchedule.TargetProperty.Builder	kinesisParameters(IResolvable kinesisParameters)	Sets the value of CfnSchedule.TargetProperty.getKinesisParameters()
CfnSchedule.TargetProperty.Builder	kinesisParameters(CfnSchedule.KinesisParametersProperty kinesisParameters)	Sets the value of CfnSchedule.TargetProperty.getKinesisParameters()
CfnSchedule.TargetProperty.Builder	retryPolicy(IResolvable retryPolicy)	Sets the value of CfnSchedule.TargetProperty.getRetryPolicy()
CfnSchedule.TargetProperty.Builder	retryPolicy(CfnSchedule.RetryPolicyProperty retryPolicy)	Sets the value of CfnSchedule.TargetProperty.getRetryPolicy()
CfnSchedule.TargetProperty.Builder	roleArn(String roleArn)	Sets the value of CfnSchedule.TargetProperty.getRoleArn()
CfnSchedule.TargetProperty.Builder	sageMakerPipelineParameters(IResolvable sageMakerPipelineParameters)	Sets the value of CfnSchedule.TargetProperty.getSageMakerPipelineParameters()
CfnSchedule.TargetProperty.Builder	sageMakerPipelineParameters(CfnSchedule.SageMakerPipelineParametersProperty sageMakerPipelineParameters)	Sets the value of CfnSchedule.TargetProperty.getSageMakerPipelineParameters()
CfnSchedule.TargetProperty.Builder	sqsParameters(IResolvable sqsParameters)	Sets the value of CfnSchedule.TargetProperty.getSqsParameters()
CfnSchedule.TargetProperty.Builder	sqsParameters(CfnSchedule.SqsParametersProperty sqsParameters)	Sets the value of CfnSchedule.TargetProperty.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(Stable)
public CfnSchedule.TargetProperty.Builder arn(String arn)

Sets the value of CfnSchedule.TargetProperty.getArn()

Parameters:

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

Returns:

this

roleArn

@Stability(Stable)
public CfnSchedule.TargetProperty.Builder roleArn(String roleArn)

Sets the value of CfnSchedule.TargetProperty.getRoleArn()

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked. This parameter is required.

Returns:

this

deadLetterConfig

@Stability(Stable)
public CfnSchedule.TargetProperty.Builder deadLetterConfig(IResolvable deadLetterConfig)

Sets the value of CfnSchedule.TargetProperty.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

deadLetterConfig

@Stability(Stable)
public CfnSchedule.TargetProperty.Builder deadLetterConfig(CfnSchedule.DeadLetterConfigProperty deadLetterConfig)

Sets the value of CfnSchedule.TargetProperty.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(Stable)
public CfnSchedule.TargetProperty.Builder ecsParameters(IResolvable ecsParameters)

Sets the value of CfnSchedule.TargetProperty.getEcsParameters()

Parameters:

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

Returns:

this

ecsParameters

@Stability(Stable)
public CfnSchedule.TargetProperty.Builder ecsParameters(CfnSchedule.EcsParametersProperty ecsParameters)

Sets the value of CfnSchedule.TargetProperty.getEcsParameters()

Parameters:

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

Returns:

this

eventBridgeParameters

@Stability(Stable)
public CfnSchedule.TargetProperty.Builder eventBridgeParameters(IResolvable eventBridgeParameters)

Sets the value of CfnSchedule.TargetProperty.getEventBridgeParameters()

Parameters:

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

Returns:

this

eventBridgeParameters

@Stability(Stable)
public CfnSchedule.TargetProperty.Builder eventBridgeParameters(CfnSchedule.EventBridgeParametersProperty eventBridgeParameters)

Sets the value of CfnSchedule.TargetProperty.getEventBridgeParameters()

Parameters:

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

Returns:

this

input

@Stability(Stable)
public CfnSchedule.TargetProperty.Builder input(String input)

Sets the value of CfnSchedule.TargetProperty.getInput()

Parameters:

input - The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda , AWS Step Functions , or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, Amazon EventBridge Scheduler delivers a default notification to the target.

Returns:

this

kinesisParameters

@Stability(Stable)
public CfnSchedule.TargetProperty.Builder kinesisParameters(IResolvable kinesisParameters)

Sets the value of CfnSchedule.TargetProperty.getKinesisParameters()

Parameters:

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

Returns:

this

kinesisParameters

@Stability(Stable)
public CfnSchedule.TargetProperty.Builder kinesisParameters(CfnSchedule.KinesisParametersProperty kinesisParameters)

Sets the value of CfnSchedule.TargetProperty.getKinesisParameters()

Parameters:

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

Returns:

this

retryPolicy

@Stability(Stable)
public CfnSchedule.TargetProperty.Builder retryPolicy(IResolvable retryPolicy)

Sets the value of CfnSchedule.TargetProperty.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

retryPolicy

@Stability(Stable)
public CfnSchedule.TargetProperty.Builder retryPolicy(CfnSchedule.RetryPolicyProperty retryPolicy)

Sets the value of CfnSchedule.TargetProperty.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(Stable)
public CfnSchedule.TargetProperty.Builder sageMakerPipelineParameters(IResolvable sageMakerPipelineParameters)

Sets the value of CfnSchedule.TargetProperty.getSageMakerPipelineParameters()

Parameters:

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

Returns:

this

sageMakerPipelineParameters

@Stability(Stable)
public CfnSchedule.TargetProperty.Builder sageMakerPipelineParameters(CfnSchedule.SageMakerPipelineParametersProperty sageMakerPipelineParameters)

Sets the value of CfnSchedule.TargetProperty.getSageMakerPipelineParameters()

Parameters:

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

Returns:

this

sqsParameters

@Stability(Stable)
public CfnSchedule.TargetProperty.Builder sqsParameters(IResolvable sqsParameters)

Sets the value of CfnSchedule.TargetProperty.getSqsParameters()

Parameters:

sqsParameters - The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide .

Returns:

this

sqsParameters

@Stability(Stable)
public CfnSchedule.TargetProperty.Builder sqsParameters(CfnSchedule.SqsParametersProperty sqsParameters)

Sets the value of CfnSchedule.TargetProperty.getSqsParameters()

Parameters:

sqsParameters - The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide .

Returns:

this

build

@Stability(Stable)
public CfnSchedule.TargetProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnSchedule.TargetProperty>

Returns:

a new instance of CfnSchedule.TargetProperty

Throws:

NullPointerException - if any required attribute was not provided