interface StepFunctionsActionProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.IoT.CfnTopicRule.StepFunctionsActionProperty |
 Java | software.amazon.awscdk.services.iot.CfnTopicRule.StepFunctionsActionProperty |
 Python | aws_cdk.aws_iot.CfnTopicRule.StepFunctionsActionProperty |
 TypeScript | @aws-cdk/aws-iot » CfnTopicRule » StepFunctionsActionProperty |
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 * as iot from '@aws-cdk/aws-iot';
const stepFunctionsActionProperty: iot.CfnTopicRule.StepFunctionsActionProperty = {
roleArn: 'roleArn',
stateMachineName: 'stateMachineName',
// the properties below are optional
executionNamePrefix: 'executionNamePrefix',
};
Properties
| Name | Type | Description |
|---|---|---|
| role | string | The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution"). |
| state | string | The name of the Step Functions state machine whose execution will be started. |
| execution | string | (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. |
roleArn
Type:
string
The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
stateMachineName
Type:
string
The name of the Step Functions state machine whose execution will be started.
executionNamePrefix?
Type:
string
(optional)
(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.