Package software.amazon.awscdk.cfnpropertymixins.services.scheduler

Class CfnSchedulePropsMixin.TargetProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.scheduler.CfnSchedulePropsMixin.TargetProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnSchedulePropsMixin.TargetProperty

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

A builder for CfnSchedulePropsMixin.TargetProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Sets the value of CfnSchedulePropsMixin.TargetProperty.getArn()

Parameters:

arn - The Amazon Resource Name (ARN) of the target.

Returns:

this

arn

@Stability(Stable)
public CfnSchedulePropsMixin.TargetProperty.Builder arn(IFunctionRef arn)

Sets the value of CfnSchedulePropsMixin.TargetProperty.getArn()

Parameters:

arn - The Amazon Resource Name (ARN) of the target.

Returns:

this

arn

@Stability(Stable)
public CfnSchedulePropsMixin.TargetProperty.Builder arn(IQueueRef arn)

Sets the value of CfnSchedulePropsMixin.TargetProperty.getArn()

Parameters:

arn - The Amazon Resource Name (ARN) of the target.

Returns:

this

arn

@Stability(Stable)
public CfnSchedulePropsMixin.TargetProperty.Builder arn(IStateMachineRef arn)

Sets the value of CfnSchedulePropsMixin.TargetProperty.getArn()

Parameters:

arn - The Amazon Resource Name (ARN) of the target.

Returns:

this

deadLetterConfig

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

Sets the value of CfnSchedulePropsMixin.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 CfnSchedulePropsMixin.TargetProperty.Builder deadLetterConfig(CfnSchedulePropsMixin.DeadLetterConfigProperty deadLetterConfig)

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

Sets the value of CfnSchedulePropsMixin.TargetProperty.getEcsParameters()

Parameters:

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

Returns:

this

ecsParameters

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

Sets the value of CfnSchedulePropsMixin.TargetProperty.getEcsParameters()

Parameters:

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

Returns:

this

eventBridgeParameters

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

Sets the value of CfnSchedulePropsMixin.TargetProperty.getEventBridgeParameters()

Parameters:

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

Returns:

this

eventBridgeParameters

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

Sets the value of CfnSchedulePropsMixin.TargetProperty.getEventBridgeParameters()

Parameters:

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

Returns:

this

input

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

Sets the value of CfnSchedulePropsMixin.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 CfnSchedulePropsMixin.TargetProperty.Builder kinesisParameters(IResolvable kinesisParameters)

Sets the value of CfnSchedulePropsMixin.TargetProperty.getKinesisParameters()

Parameters:

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

Returns:

this

kinesisParameters

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

Sets the value of CfnSchedulePropsMixin.TargetProperty.getKinesisParameters()

Parameters:

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

Returns:

this

retryPolicy

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

Sets the value of CfnSchedulePropsMixin.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 CfnSchedulePropsMixin.TargetProperty.Builder retryPolicy(CfnSchedulePropsMixin.RetryPolicyProperty retryPolicy)

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

roleArn

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

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

Returns:

this

roleArn

@Stability(Stable)
public CfnSchedulePropsMixin.TargetProperty.Builder roleArn(IRoleRef roleArn)

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

Returns:

this

sageMakerPipelineParameters

@Stability(Stable)
public CfnSchedulePropsMixin.TargetProperty.Builder sageMakerPipelineParameters(IResolvable sageMakerPipelineParameters)

Sets the value of CfnSchedulePropsMixin.TargetProperty.getSageMakerPipelineParameters()

Parameters:

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

Returns:

this

sageMakerPipelineParameters

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

Sets the value of CfnSchedulePropsMixin.TargetProperty.getSageMakerPipelineParameters()

Parameters:

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

Returns:

this

sqsParameters

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

Sets the value of CfnSchedulePropsMixin.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 CfnSchedulePropsMixin.TargetProperty.Builder sqsParameters(CfnSchedulePropsMixin.SqsParametersProperty sqsParameters)

Sets the value of CfnSchedulePropsMixin.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 CfnSchedulePropsMixin.TargetProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnSchedulePropsMixin.TargetProperty

Throws:

NullPointerException - if any required attribute was not provided