StepFunctionsStateMachineActionProps

class aws_cdk.aws_iot_actions_alpha.StepFunctionsStateMachineActionProps(*, role=None, execution_name_prefix=None)

Bases: CommonActionProps

(experimental) Configuration properties of an action for the Step Functions State Machine.

Parameters:

• role (Optional[IRole]) – (experimental) The IAM role that allows access to AWS service. Default: a new role will be created

• execution_name_prefix (Optional[str]) – (experimental) Name of the state machine execution prefix. The name given to the state machine execution consists of this prefix followed by a UUID. Step Functions creates a unique name for each state machine execution if one is not provided. Default: : None - Step Functions creates a unique name for each state machine execution if one is not provided.

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iot_actions_alpha as iot_actions_alpha
from aws_cdk import aws_iam as iam

# role: iam.Role

step_functions_state_machine_action_props = iot_actions_alpha.StepFunctionsStateMachineActionProps(
    execution_name_prefix="executionNamePrefix",
    role=role
)

Attributes

execution_name_prefix

(experimental) Name of the state machine execution prefix.

The name given to the state machine execution consists of this prefix followed by a UUID. Step Functions creates a unique name for each state machine execution if one is not provided.

Default:

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

See:

https://docs.aws.amazon.com/iot/latest/developerguide/stepfunctions-rule-action.html#stepfunctions-rule-action-parameters

Stability:

experimental

role

(experimental) The IAM role that allows access to AWS service.

Default:

a new role will be created

Stability:

experimental