software.amazon.awscdk.services.iot.actions.alpha.StepFunctionsStateMachineAction Maven / Gradle / Ivy
Show all versions of iot-actions-alpha Show documentation
package software.amazon.awscdk.services.iot.actions.alpha;
/**
* (experimental) The action to put the record from an MQTT message to the Step Functions State Machine.
*
* Example:
*
*
* StateMachine stateMachine = StateMachine.Builder.create(this, "SM")
* .definitionBody(DefinitionBody.fromChainable(Wait.Builder.create(this, "Hello").time(WaitTime.duration(Duration.seconds(10))).build()))
* .build();
* TopicRule.Builder.create(this, "TopicRule")
* .sql(IotSql.fromStringAsVer20160323("SELECT * FROM 'device/+/data'"))
* .actions(List.of(
* new StepFunctionsStateMachineAction(stateMachine)))
* .build();
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-10-04T00:39:42.249Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.iot.actions.alpha.$Module.class, fqn = "@aws-cdk/aws-iot-actions-alpha.StepFunctionsStateMachineAction")
public class StepFunctionsStateMachineAction extends software.amazon.jsii.JsiiObject implements software.amazon.awscdk.services.iot.alpha.IAction {
protected StepFunctionsStateMachineAction(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected StepFunctionsStateMachineAction(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param stateMachine The Step Functions Start Machine which shoud be executed. This parameter is required.
* @param props Optional properties to not use default.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public StepFunctionsStateMachineAction(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.stepfunctions.IStateMachine stateMachine, final @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.iot.actions.alpha.StepFunctionsStateMachineActionProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(stateMachine, "stateMachine is required"), props });
}
/**
* @param stateMachine The Step Functions Start Machine which shoud be executed. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public StepFunctionsStateMachineAction(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.stepfunctions.IStateMachine stateMachine) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(stateMachine, "stateMachine is required") });
}
/**
* (experimental) A fluent builder for {@link software.amazon.awscdk.services.iot.actions.alpha.StepFunctionsStateMachineAction}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param stateMachine The Step Functions Start Machine which shoud be executed. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static Builder create(final software.amazon.awscdk.services.stepfunctions.IStateMachine stateMachine) {
return new Builder(stateMachine);
}
private final software.amazon.awscdk.services.stepfunctions.IStateMachine stateMachine;
private software.amazon.awscdk.services.iot.actions.alpha.StepFunctionsStateMachineActionProps.Builder props;
private Builder(final software.amazon.awscdk.services.stepfunctions.IStateMachine stateMachine) {
this.stateMachine = stateMachine;
}
/**
* (experimental) The IAM role that allows access to AWS service.
*
* Default: a new role will be created
*
* @return {@code this}
* @param role The IAM role that allows access to AWS service. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder role(final software.amazon.awscdk.services.iam.IRole role) {
this.props().role(role);
return this;
}
/**
* (experimental) Name of the state machine execution prefix.
*
* The name given to the state machine execution consists of this prefix followed by a UUID. Step Functions creates a unique name for each state machine execution if one is not provided.
*
* Default: : None - Step Functions creates a unique name for each state machine execution if one is not provided.
*
* @return {@code this}
* @see https://docs.aws.amazon.com/iot/latest/developerguide/stepfunctions-rule-action.html#stepfunctions-rule-action-parameters
* @param executionNamePrefix Name of the state machine execution prefix. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder executionNamePrefix(final java.lang.String executionNamePrefix) {
this.props().executionNamePrefix(executionNamePrefix);
return this;
}
/**
* @return a newly built instance of {@link software.amazon.awscdk.services.iot.actions.alpha.StepFunctionsStateMachineAction}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public software.amazon.awscdk.services.iot.actions.alpha.StepFunctionsStateMachineAction build() {
return new software.amazon.awscdk.services.iot.actions.alpha.StepFunctionsStateMachineAction(
this.stateMachine,
this.props != null ? this.props.build() : null
);
}
private software.amazon.awscdk.services.iot.actions.alpha.StepFunctionsStateMachineActionProps.Builder props() {
if (this.props == null) {
this.props = new software.amazon.awscdk.services.iot.actions.alpha.StepFunctionsStateMachineActionProps.Builder();
}
return this.props;
}
}
}