Class StateMachineGrants

Collection of grant methods for a IStateMachineRef.

Inheritance

StateMachineGrants

Namespace: Amazon.CDK.AWS.StepFunctions

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class StateMachineGrants : DeputyBase

Syntax (vb)

Public Class StateMachineGrants Inherits DeputyBase

Remarks

ExampleMetadata: fixture=_generated

Examples

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

Synopsis

Properties

Resource

Collection of grant methods for a IStateMachineRef.

Methods

Actions(IGrantable, params string[])	Grant the given identity custom permissions.
Execution(IGrantable, params string[])	Grant the given identity permissions to start an execution of this state machine.
FromStateMachine(IStateMachineRef)	Creates grants for StateMachineGrants.
Read(IGrantable)	Grant the given identity permissions to read results from state machine.
RedriveExecution(IGrantable)	Grant the given identity permission to redrive the execution of the state machine.
StartExecution(IGrantable)	Grant the given identity permissions to start an execution of this state machine.
StartSyncExecution(IGrantable)	Grant the given identity permissions to start a synchronous execution of this state machine.
TaskResponse(IGrantable)	Grant the given identity task response permissions on a state machine.

Properties

Resource

Collection of grant methods for a IStateMachineRef.

protected virtual IStateMachineRef Resource { get; }

Property Value

IStateMachineRef

Remarks

ExampleMetadata: fixture=_generated

Examples

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

Methods

Actions(IGrantable, params string[])

Grant the given identity custom permissions.

public virtual Grant Actions(IGrantable identity, params string[] actions)

Parameters

identity IGrantable
actions string[]

Returns

Grant

Remarks

ExampleMetadata: fixture=_generated

Execution(IGrantable, params string[])

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

public virtual Grant Execution(IGrantable grantee, params string[] actions)

Parameters

grantee IGrantable: The principal.
actions string[]: The principal.

Returns

Grant

Remarks

ExampleMetadata: fixture=_generated

FromStateMachine(IStateMachineRef)

Creates grants for StateMachineGrants.

public static StateMachineGrants FromStateMachine(IStateMachineRef resource)

Parameters

resource IStateMachineRef

Returns

StateMachineGrants

Remarks

ExampleMetadata: fixture=_generated

Read(IGrantable)

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

public virtual Grant Read(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

Remarks

ExampleMetadata: fixture=_generated

RedriveExecution(IGrantable)

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

public virtual Grant RedriveExecution(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

Remarks

ExampleMetadata: fixture=_generated

StartExecution(IGrantable)

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

public virtual Grant StartExecution(IGrantable grantee)

Parameters

grantee IGrantable: The principal.

Returns

Grant

Remarks

ExampleMetadata: fixture=_generated

StartSyncExecution(IGrantable)

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

public virtual Grant StartSyncExecution(IGrantable grantee)

Parameters

grantee IGrantable: The principal.

Returns

Grant

Remarks

ExampleMetadata: fixture=_generated

TaskResponse(IGrantable)

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

public virtual Grant TaskResponse(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

Remarks

ExampleMetadata: fixture=_generated