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

Class StepFunctionsStartExecution

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.scheduler.targets.alpha.ScheduleTargetBase

software.amazon.awscdk.services.scheduler.targets.alpha.StepFunctionsStartExecution

All Implemented Interfaces:

IScheduleTarget, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-02-26T00:07:49.540Z")
@Stability(Experimental)
public class StepFunctionsStartExecution
extends ScheduleTargetBase
implements IScheduleTarget

(experimental) Use an AWS Step function as a target for AWS EventBridge Scheduler.

Example:

 import software.amazon.awscdk.services.stepfunctions.*;
 import software.amazon.awscdk.services.stepfunctions.tasks.*;
 Map<String, String> payload = Map.of(
         "Name", "MyParameter",
         "Value", "🌥️");
 CallAwsService putParameterStep = CallAwsService.Builder.create(this, "PutParameter")
         .service("ssm")
         .action("putParameter")
         .iamResources(List.of("*"))
         .parameters(Map.of(
                 "Name.$", "$.Name",
                 "Value.$", "$.Value",
                 "Type", "String",
                 "Overwrite", true))
         .build();
 StateMachine stateMachine = StateMachine.Builder.create(this, "StateMachine")
         .definitionBody(DefinitionBody.fromChainable(putParameterStep))
         .build();
 Schedule.Builder.create(this, "Schedule")
         .schedule(ScheduleExpression.rate(Duration.hours(1)))
         .target(StepFunctionsStartExecution.Builder.create(stateMachine)
                 .input(ScheduleTargetInput.fromObject(payload))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StepFunctionsStartExecution.Builder	(experimental) A fluent builder for StepFunctionsStartExecution.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.scheduler.alpha.IScheduleTarget

IScheduleTarget.Jsii$Default, IScheduleTarget.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	StepFunctionsStartExecution(IStateMachine stateMachine, ScheduleTargetBaseProps props)
protected	StepFunctionsStartExecution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	StepFunctionsStartExecution(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
protected void	addTargetActionToRole(IRole role)

Methods inherited from class software.amazon.awscdk.services.scheduler.targets.alpha.ScheduleTargetBase

bind, bindBaseTargetConfig, getTargetArn

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.services.scheduler.alpha.IScheduleTarget

bind

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

StepFunctionsStartExecution

protected StepFunctionsStartExecution(software.amazon.jsii.JsiiObjectRef objRef)

StepFunctionsStartExecution

protected StepFunctionsStartExecution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

StepFunctionsStartExecution

@Stability(Experimental)
public StepFunctionsStartExecution(@NotNull
 IStateMachine stateMachine,
 @NotNull
 ScheduleTargetBaseProps props)

Parameters:

stateMachine - This parameter is required.

props - This parameter is required.

Method Details

addTargetActionToRole

@Stability(Experimental)
protected void addTargetActionToRole(@NotNull
 IRole role)

Specified by:

addTargetActionToRole in class ScheduleTargetBase

Parameters:

role - This parameter is required.