aws-cdk-lib.aws_iot.CfnTopicRule.StepFunctionsActionProperty

interface StepFunctionsActionProperty

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnTopicRule.StepFunctionsActionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnTopicRule_StepFunctionsActionProperty
Javasoftware.amazon.awscdk.services.iot.CfnTopicRule.StepFunctionsActionProperty
Pythonaws_cdk.aws_iot.CfnTopicRule.StepFunctionsActionProperty
TypeScript aws-cdk-lib » 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 { 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

NameTypeDescription
roleArnstringThe ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
stateMachineNamestringThe name of the Step Functions state machine whose execution will be started.
executionNamePrefix?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.