Skip to content
v2.277.0

StateMachineGrants Facade ​

Collection of grant methods for a IStateMachineRef.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions as interfaces_stepfunctions } from 'aws-cdk-lib/interfaces';

declare const stateMachineRef: interfaces_stepfunctions.IStateMachineRef;
const stateMachineGrants = stepfunctions.StateMachineGrants.fromStateMachine(stateMachineRef);
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_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)
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.stepfunctions.*;
import software.amazon.awscdk.interfaces.stepfunctions.*;

IStateMachineRef stateMachineRef;

StateMachineGrants stateMachineGrants = StateMachineGrants.fromStateMachine(stateMachineRef);
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.StepFunctions;
using Amazon.CDK.Interfaces.StepFunctions;

IStateMachineRef stateMachineRef;

var stateMachineGrants = StateMachineGrants.FromStateMachine(stateMachineRef);
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"
import "github.com/aws/aws-cdk-go/awscdk"

var stateMachineRef IStateMachineRef

stateMachineGrants := awscdk.Aws_stepfunctions.StateMachineGrants_FromStateMachine(stateMachineRef)

Methods ​

actions(identity: IGrantable, ...actions: string[]): Grantdef actions(self, identity: IGrantable, actions: str) -> Grantpublic Grant actions(IGrantable identity, String actions)public Grant Actions(IGrantable identity, string actions)func Actions(Identity IGrantable, Actions *string) Grant #
Grant the given identity custom permissions.
execution(grantee: IGrantable, ...actions: string[]): Grantdef execution(self, grantee: IGrantable, actions: str) -> Grantpublic Grant execution(IGrantable grantee, String actions)public Grant Execution(IGrantable grantee, string actions)func Execution(Grantee IGrantable, Actions *string) Grant #
Grant the given identity permissions to start an execution of this state machine.
1 parameter

Parameters

  • granteegranteegranteegranteeGrantee — The principal.
fromStateMachine(resource: IStateMachineRef): StateMachineGrants // chainable@staticmethod def from_state_machine(resource: IStateMachineRef) -> StateMachineGrantspublic static StateMachineGrants fromStateMachine(IStateMachineRef resource)public static StateMachineGrants FromStateMachine(IStateMachineRef resource)func FromStateMachine(Resource IStateMachineRef) StateMachineGrants static #
Creates grants for StateMachineGrants.
read(grantee: IGrantable): Grantdef read(self, grantee: IGrantable) -> Grantpublic Grant read(IGrantable grantee)public Grant Read(IGrantable grantee)func Read(Grantee IGrantable) Grant #
Grant the given identity permissions to read results from state machine.
redriveExecution(grantee: IGrantable): Grantdef redrive_execution(self, grantee: IGrantable) -> Grantpublic Grant redriveExecution(IGrantable grantee)public Grant RedriveExecution(IGrantable grantee)func RedriveExecution(Grantee IGrantable) Grant #
Grant the given identity permission to redrive the execution of the state machine.
startExecution(grantee: IGrantable): Grantdef start_execution(self, grantee: IGrantable) -> Grantpublic Grant startExecution(IGrantable grantee)public Grant StartExecution(IGrantable grantee)func StartExecution(Grantee IGrantable) Grant #
Grant the given identity permissions to start an execution of this state machine.
1 parameter

Parameters

  • granteegranteegranteegranteeGrantee — The principal.
startSyncExecution(grantee: IGrantable): Grantdef start_sync_execution(self, grantee: IGrantable) -> Grantpublic Grant startSyncExecution(IGrantable grantee)public Grant StartSyncExecution(IGrantable grantee)func StartSyncExecution(Grantee IGrantable) Grant #
Grant the given identity permissions to start a synchronous execution of this state machine.
1 parameter

Parameters

  • granteegranteegranteegranteeGrantee — The principal.
taskResponse(grantee: IGrantable): Grantdef task_response(self, grantee: IGrantable) -> Grantpublic Grant taskResponse(IGrantable grantee)public Grant TaskResponse(IGrantable grantee)func TaskResponse(Grantee IGrantable) Grant #
Grant the given identity task response permissions on a state machine.