Interface IStateMachine

A State Machine.

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Env

IResource.Stack

IConstruct.Node

IGrantable.GrantPrincipal

Namespace: Amazon.CDK.AWS.StepFunctions

Assembly: Amazon.CDK.AWS.StepFunctions.dll

Syntax (csharp)

public interface IStateMachine : IResource, IConstruct, IDependable, IGrantable

Syntax (vb)

Public Interface IStateMachine
    Inherits IResource, IConstruct, IConstruct, IDependable, IGrantable

Synopsis

Properties

StateMachineArn

The ARN of the state machine.

Methods

Grant(IGrantable, String[])	Grant the given identity custom permissions.
GrantExecution(IGrantable, String[])	Grant the given identity permissions for all executions of a state machine.
GrantRead(IGrantable)	Grant the given identity read permissions for this state machine.
GrantStartExecution(IGrantable)	Grant the given identity permissions to start an execution of this state machine.
GrantStartSyncExecution(IGrantable)	Grant the given identity permissions to start a synchronous execution of this state machine.
GrantTaskResponse(IGrantable)	Grant the given identity read permissions for this state machine.
Metric(String, IMetricOptions)	Return the given named metric for this State Machine's executions.
MetricAborted(IMetricOptions)	Metric for the number of executions that were aborted.
MetricFailed(IMetricOptions)	Metric for the number of executions that failed.
MetricStarted(IMetricOptions)	Metric for the number of executions that were started.
MetricSucceeded(IMetricOptions)	Metric for the number of executions that succeeded.
MetricThrottled(IMetricOptions)	Metric for the number of executions that were throttled.
MetricTime(IMetricOptions)	Metric for the interval, in milliseconds, between the time the execution starts and the time it closes.
MetricTimedOut(IMetricOptions)	Metric for the number of executions that timed out.

Properties

StateMachineArn

The ARN of the state machine.

string StateMachineArn { get; }

Property Value

System.String

Remarks

Attribute: true

Methods

Grant(IGrantable, String[])

Grant the given identity custom permissions.

Grant Grant(IGrantable identity, params string[] actions)

Parameters

identity IGrantable

The principal.

actions System.String[]

The list of desired actions.

Returns

Grant

GrantExecution(IGrantable, String[])

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

Grant GrantExecution(IGrantable identity, params string[] actions)

Parameters

identity IGrantable

The principal.

actions System.String[]

The list of desired actions.

Returns

Grant

GrantRead(IGrantable)

Grant the given identity read permissions for this state machine.

Grant GrantRead(IGrantable identity)

Parameters

identity IGrantable

The principal.

Returns

Grant

GrantStartExecution(IGrantable)

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

Grant GrantStartExecution(IGrantable identity)

Parameters

identity IGrantable

The principal.

Returns

Grant

GrantStartSyncExecution(IGrantable)

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

Grant GrantStartSyncExecution(IGrantable identity)

Parameters

identity IGrantable

The principal.

Returns

Grant

GrantTaskResponse(IGrantable)

Grant the given identity read permissions for this state machine.

Grant GrantTaskResponse(IGrantable identity)

Parameters

identity IGrantable

The principal.

Returns

Grant

Metric(String, IMetricOptions)

Return the given named metric for this State Machine's executions.

Metric Metric(string metricName, IMetricOptions props = null)

Parameters

metricName System.String

props IMetricOptions

Returns

Metric

Remarks

Default: - sum over 5 minutes

MetricAborted(IMetricOptions)

Metric for the number of executions that were aborted.

Metric MetricAborted(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: - sum over 5 minutes

MetricFailed(IMetricOptions)

Metric for the number of executions that failed.

Metric MetricFailed(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: - sum over 5 minutes

MetricStarted(IMetricOptions)

Metric for the number of executions that were started.

Metric MetricStarted(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: - sum over 5 minutes

MetricSucceeded(IMetricOptions)

Metric for the number of executions that succeeded.

Metric MetricSucceeded(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: - sum over 5 minutes

MetricThrottled(IMetricOptions)

Metric for the number of executions that were throttled.

Metric MetricThrottled(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: sum over 5 minutes

MetricTime(IMetricOptions)

Metric for the interval, in milliseconds, between the time the execution starts and the time it closes.

Metric MetricTime(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: - sum over 5 minutes

MetricTimedOut(IMetricOptions)

Metric for the number of executions that timed out.

Metric MetricTimedOut(IMetricOptions props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: - sum over 5 minutes