StateMachineGrants

class aws_cdk.aws_stepfunctions.StateMachineGrants(*args: Any, **kwargs)

Bases: object

Collection of grant methods for a IStateMachineRef.

ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_stepfunctions as stepfunctions
from aws_cdk.interfaces import aws_stepfunctions as interfaces_stepfunctions

# state_machine_ref: interfaces_stepfunctions.IStateMachineRef

state_machine_grants = stepfunctions.StateMachineGrants.from_state_machine(state_machine_ref)

Methods

actions(identity, *actions)

Grant the given identity custom permissions.

Parameters:

identity (IGrantable)
actions (str)

Return type:

Grant

execution(grantee, *actions)

Grant the given identity permissions to start an execution of this state machine.

Parameters:

grantee (IGrantable) – The principal.
actions (str)

Return type:

Grant

read(grantee)

Grant the given identity permissions to read results from state machine.

Parameters:: grantee (IGrantable)
Return type:: Grant

redrive_execution(grantee)

Grant the given identity permission to redrive the execution of the state machine.

Parameters:: grantee (IGrantable)
Return type:: Grant

start_execution(grantee)

Grant the given identity permissions to start an execution of this state machine.

Parameters:: grantee (IGrantable) – The principal.
Return type:: Grant

start_sync_execution(grantee)

Grant the given identity permissions to start a synchronous execution of this state machine.

Parameters:: grantee (IGrantable) – The principal.
Return type:: Grant

task_response(grantee)

Grant the given identity task response permissions on a state machine.

Parameters:: grantee (IGrantable)
Return type:: Grant

Static Methods

classmethod from_state_machine(resource)

Creates grants for StateMachineGrants.

Parameters:: resource (IStateMachineRef)
Return type:: StateMachineGrants