class StateMachineGrants

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.StateMachineGrants
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#StateMachineGrants
Java	software.amazon.awscdk.services.stepfunctions.StateMachineGrants
Python	aws_cdk.aws_stepfunctions.StateMachineGrants
TypeScript (source)	aws-cdk-lib » aws_stepfunctions » StateMachineGrants

Collection of grant methods for a IStateMachineRef.

Example

// 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);

Properties

Name	Type	Description
resource	IStateMachineRef

---

resource

Type: IStateMachineRef

Methods

Name	Description
actions(identity, ...actions)	Grant the given identity custom permissions.
execution(grantee, ...actions)	Grant the given identity permissions to start an execution of this state machine.
read(grantee)	Grant the given identity permissions to read results from state machine.
redriveExecution(grantee)	Grant the given identity permission to redrive the execution of the state machine.
startExecution(grantee)	Grant the given identity permissions to start an execution of this state machine.
startSyncExecution(grantee)	Grant the given identity permissions to start a synchronous execution of this state machine.
taskResponse(grantee)	Grant the given identity task response permissions on a state machine.
static fromStateMachine(resource)	Creates grants for StateMachineGrants.

---

actions(identity, ...actions)

public actions(identity: IGrantable, ...actions: string[]): Grant

Parameters

• identity IGrantable
• actions string

Returns

• Grant

Grant the given identity custom permissions.

---

execution(grantee, ...actions)

public execution(grantee: IGrantable, ...actions: string[]): Grant

Parameters

• grantee IGrantable — The principal.
• actions string

Returns

• Grant

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

---

read(grantee)

public read(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

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

---

redriveExecution(grantee)

public redriveExecution(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

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

---

startExecution(grantee)

public startExecution(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal.

Returns

• Grant

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

---

startSyncExecution(grantee)

public startSyncExecution(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal.

Returns

• Grant

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

---

taskResponse(grantee)

public taskResponse(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

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

---

static fromStateMachine(resource)

public static fromStateMachine(resource: IStateMachineRef): StateMachineGrants

Parameters

• resource IStateMachineRef

Returns

• StateMachineGrants

Creates grants for StateMachineGrants.