ScheduleTargetProps

class aws_cdk.aws_scheduler_alpha.ScheduleTargetProps(*, input=None, max_event_age=None, retry_attempts=None)

Bases: object

Parameters:

input (Optional[ScheduleTargetInput]) – (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.
max_event_age (Optional[Duration]) – (experimental) The maximum amount of time, in seconds, to continue to make retry attempts. Default: - The target’s maximumEventAgeInSeconds is used.
retry_attempts (Union[int, float, None]) – (experimental) The maximum number of retry attempts to make before the request fails. Default: - The target’s maximumRetryAttempts is used.

Stability:

experimental

ExampleMetadata:

infused

Example:

# target: targets.LambdaInvoke


one_time_schedule = Schedule(self, "Schedule",
    schedule=ScheduleExpression.rate(cdk.Duration.hours(12)),
    target=target,
    target_overrides=ScheduleTargetProps(
        input=ScheduleTargetInput.from_text("Overriding Target Input"),
        max_event_age=Duration.seconds(180),
        retry_attempts=5
    )
)

Attributes

input

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

Stability:

experimental

max_event_age

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

Default:

The target’s maximumEventAgeInSeconds is used.

Stability:

experimental

retry_attempts

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

Default:

The target’s maximumRetryAttempts is used.

Stability:

experimental