aws-cdk-lib.aws_iot.CfnTopicRule.StepFunctionsActionProperty

StepFunctionsActionProperty Struct

Starts execution of a Step Functions state machine.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iot as iot } from 'aws-cdk-lib';
const stepFunctionsActionProperty: iot.CfnTopicRule.StepFunctionsActionProperty = {
  roleArn: 'roleArn',
  stateMachineName: 'stateMachineName',

  // the properties below are optional
  executionNamePrefix: 'executionNamePrefix',
};

Properties

executionNamePrefix?optionalstringexecution_name_prefix?optionalstrexecutionNamePrefix?optionalStringExecutionNamePrefix?optionalstringExecutionNamePrefix?optional*string#

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

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#

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

stateMachineNamestringstate_machine_namestrstateMachineNameStringStateMachineNamestringStateMachineName*stringrequired#

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