interface StepFunctionsActionProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.IoT.Mixins.CfnTopicRulePropsMixin.StepFunctionsActionProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiot/mixins#CfnTopicRulePropsMixin_StepFunctionsActionProperty
Java	software.amazon.awscdk.mixins.preview.services.iot.mixins.CfnTopicRulePropsMixin.StepFunctionsActionProperty
Python	aws_cdk.mixins_preview.aws_iot.mixins.CfnTopicRulePropsMixin.StepFunctionsActionProperty
TypeScript	@aws-cdk/mixins-preview » aws_iot » mixins » CfnTopicRulePropsMixin » StepFunctionsActionProperty

Starts execution of a Step Functions state machine.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html

Example

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

Properties

Name	Type	Description
executionNamePrefix?	string	(Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID.
roleArn?	string	The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
stateMachineName?	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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html#cfn-iot-topicrule-stepfunctionsaction-executionnameprefix

---

roleArn?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html#cfn-iot-topicrule-stepfunctionsaction-rolearn

---

stateMachineName?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-stepfunctionsaction.html#cfn-iot-topicrule-stepfunctionsaction-statemachinename