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

Interface ScheduleTargetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ScheduleTargetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:16.042Z")
@Stability(Experimental)
public interface ScheduleTargetProps
extends software.amazon.jsii.JsiiSerializable

Example:

 LambdaInvoke target;
 Schedule oneTimeSchedule = Schedule.Builder.create(this, "Schedule")
         .schedule(ScheduleExpression.rate(Duration.hours(12)))
         .target(target)
         .targetOverrides(ScheduleTargetProps.builder()
                 .input(ScheduleTargetInput.fromText("Overriding Target Input"))
                 .maxEventAge(Duration.seconds(180))
                 .retryAttempts(5)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ScheduleTargetProps.Builder	A builder for ScheduleTargetProps
static final class	ScheduleTargetProps.Jsii$Proxy	An implementation for ScheduleTargetProps

Method Summary

Modifier and Type	Method	Description
static ScheduleTargetProps.Builder	builder()
default ScheduleTargetInput	getInput()	(experimental) The text, or well-formed JSON, passed to the target.
default Duration	getMaxEventAge()	(experimental) The maximum amount of time, in seconds, to continue to make retry attempts.
default Number	getRetryAttempts()	(experimental) The maximum number of retry attempts to make before the request fails.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInput

@Stability(Experimental)
@Nullable
default ScheduleTargetInput getInput()

(experimental) 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.

Default: - The target's input is used.

getMaxEventAge

@Stability(Experimental)
@Nullable
default Duration getMaxEventAge()

(experimental) The maximum amount of time, in seconds, to continue to make retry attempts.

Default: - The target's maximumEventAgeInSeconds is used.

getRetryAttempts

@Stability(Experimental)
@Nullable
default Number getRetryAttempts()

(experimental) The maximum number of retry attempts to make before the request fails.

Default: - The target's maximumRetryAttempts is used.

builder

@Stability(Experimental)
static ScheduleTargetProps.Builder builder()

Returns:

a ScheduleTargetProps.Builder of ScheduleTargetProps