software.amazon.awscdk.services.stepfunctions

Interface IStateMachine

All Superinterfaces:

software.constructs.IConstruct, IDependable, IResource, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IStateMachine.Jsii$Proxy, StateMachine

@Generated(value="jsii-pacmak/1.9.0 (build 5c646d5)",
           date="2020-08-19T23:25:13.484Z")
 @Stability(value=Stable)
public interface IStateMachine
extends software.amazon.jsii.JsiiSerializable, IResource

A State Machine.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IStateMachine.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
String	getStateMachineArn() The ARN of the state machine.
Grant	grant(IGrantable identity, String... actions) Grant the given identity custom permissions.
Grant	grantExecution(IGrantable identity, String... actions) Grant the given identity permissions for all executions of a state machine.
Grant	grantRead(IGrantable identity) Grant the given identity read permissions for this state machine.
Grant	grantStartExecution(IGrantable identity) Grant the given identity permissions to start an execution of this state machine.
Grant	grantTaskResponse(IGrantable identity) Grant the given identity read permissions for this state machine.

Methods inherited from interface software.amazon.awscdk.core.IResource

getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getStateMachineArn

@Stability(value=Stable)
 @NotNull
String getStateMachineArn()

The ARN of the state machine.

grant

@Stability(value=Stable)
 @NotNull
Grant grant(@NotNull
                                               IGrantable identity,
                                               @NotNull
                                               String... actions)

Grant the given identity custom permissions.

Parameters:

identity - The principal. This parameter is required.

actions - The list of desired actions. This parameter is required.

grantExecution

@Stability(value=Stable)
 @NotNull
Grant grantExecution(@NotNull
                                                        IGrantable identity,
                                                        @NotNull
                                                        String... actions)

Grant the given identity permissions for all executions of a state machine.

Parameters:

identity - The principal. This parameter is required.

actions - The list of desired actions. This parameter is required.

grantRead

@Stability(value=Stable)
 @NotNull
Grant grantRead(@NotNull
                                                   IGrantable identity)

Grant the given identity read permissions for this state machine.

Parameters:

identity - The principal. This parameter is required.

grantStartExecution

@Stability(value=Stable)
 @NotNull
Grant grantStartExecution(@NotNull
                                                             IGrantable identity)

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

Parameters:

identity - The principal. This parameter is required.

grantTaskResponse

@Stability(value=Stable)
 @NotNull
Grant grantTaskResponse(@NotNull
                                                           IGrantable identity)

Grant the given identity read permissions for this state machine.

Parameters:

identity - The principal. This parameter is required.