StepFunctionsActionProperty Struct
Starts execution of a Step Functions state machine.
| Source | |
|---|---|
| Type last changed |
Example
ts
// 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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iot as iot
step_functions_action_property = iot.CfnTopicRule.StepFunctionsActionProperty(
role_arn="roleArn",
state_machine_name="stateMachineName",
# the properties below are optional
execution_name_prefix="executionNamePrefix"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.iot.*;
StepFunctionsActionProperty stepFunctionsActionProperty = StepFunctionsActionProperty.builder()
.roleArn("roleArn")
.stateMachineName("stateMachineName")
// the properties below are optional
.executionNamePrefix("executionNamePrefix")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
stepFunctionsActionProperty := &StepFunctionsActionProperty{
RoleArn: jsii.String("roleArn"),
StateMachineName: jsii.String("stateMachineName"),
// the properties below are optional
ExecutionNamePrefix: jsii.String("executionNamePrefix"),
}
Properties
executionNamePrefixoptionalstringexecution_name_prefixoptionalstrexecutionNamePrefixoptionalStringExecutionNamePrefixoptionalstringExecutionNamePrefixoptional*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.
The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
stateMachineNamestringstate_machine_namestrstateMachineNameStringStateMachineNamestringStateMachineName*string required #The name of the Step Functions state machine whose execution will be started.