software.amazon.awscdk.services.iot

Interface CfnTopicRule.StepFunctionsActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRule.StepFunctionsActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRule

@Stability(value=Stable)
public static interface CfnTopicRule.StepFunctionsActionProperty
extends software.amazon.jsii.JsiiSerializable

Starts execution of a Step Functions state machine.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 StepFunctionsActionProperty stepFunctionsActionProperty = StepFunctionsActionProperty.builder()
         .roleArn("roleArn")
         .stateMachineName("stateMachineName")
         // the properties below are optional
         .executionNamePrefix("executionNamePrefix")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnTopicRule.StepFunctionsActionProperty.Builder	builder()
default String	getExecutionNamePrefix() (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID.
String	getRoleArn() The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
String	getStateMachineName() The name of the Step Functions state machine whose execution will be started.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRoleArn

@Stability(value=Stable)
 @NotNull
String getRoleArn()

The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").

getStateMachineName

@Stability(value=Stable)
 @NotNull
String getStateMachineName()

The name of the Step Functions state machine whose execution will be started.

getExecutionNamePrefix

@Stability(value=Stable)
 @Nullable
default String getExecutionNamePrefix()

(Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID.

Step Functions automatically creates a unique name for each state machine execution if one is not provided.

builder

@Stability(value=Stable)
static CfnTopicRule.StepFunctionsActionProperty.Builder builder()

Returns:

a CfnTopicRule.StepFunctionsActionProperty.Builder of CfnTopicRule.StepFunctionsActionProperty