Class CfnTopicRule.StepFunctionsActionProperty

Starts execution of a Step Functions state machine.

Inheritance

object

CfnTopicRule.StepFunctionsActionProperty

Implements

CfnTopicRule.IStepFunctionsActionProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.IoT

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnTopicRule.StepFunctionsActionProperty : CfnTopicRule.IStepFunctionsActionProperty

Syntax (vb)

Public Class CfnTopicRule.StepFunctionsActionProperty Implements CfnTopicRule.IStepFunctionsActionProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoT;

             var stepFunctionsActionProperty = new StepFunctionsActionProperty {
                 RoleArn = "roleArn",
                 StateMachineName = "stateMachineName",

                 // the properties below are optional
                 ExecutionNamePrefix = "executionNamePrefix"
             };

Synopsis

Constructors

StepFunctionsActionProperty()

Starts execution of a Step Functions state machine.

Properties

ExecutionNamePrefix	(Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID.
RoleArn	The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
StateMachineName	The name of the Step Functions state machine whose execution will be started.

Constructors

StepFunctionsActionProperty()

Starts execution of a Step Functions state machine.

public StepFunctionsActionProperty()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoT;

             var stepFunctionsActionProperty = new StepFunctionsActionProperty {
                 RoleArn = "roleArn",
                 StateMachineName = "stateMachineName",

                 // the properties below are optional
                 ExecutionNamePrefix = "executionNamePrefix"
             };

Properties

ExecutionNamePrefix

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

public string? ExecutionNamePrefix { get; set; }

Property Value

string

Remarks

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

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

RoleArn

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

public string RoleArn { get; set; }

Property Value

string

Remarks

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

StateMachineName

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

public string StateMachineName { get; set; }