software.amazon.awscdk.services.stepfunctions

Class IStateMachine.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.IStateMachine.Jsii$Proxy

All Implemented Interfaces:

IResource, IResource.Jsii$Default, IGrantable, IGrantable.Jsii$Default, IStateMachine, IStateMachine.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default

Enclosing interface:

IStateMachine

@Internal
public static final class IStateMachine.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IStateMachine.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IStateMachine

IStateMachine.Jsii$Default, IStateMachine.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
ResourceEnvironment	getEnv() (experimental) The environment this resource belongs to.
IPrincipal	getGrantPrincipal() (experimental) The principal to grant permissions to.
software.constructs.Node	getNode() The tree node.
Stack	getStack() (experimental) The stack in which this resource is defined.
String	getStateMachineArn() (experimental) The ARN of the state machine.
Grant	grant(IGrantable identity, String... actions) (experimental) Grant the given identity custom permissions.
Grant	grantExecution(IGrantable identity, String... actions) (experimental) Grant the given identity permissions for all executions of a state machine.
Grant	grantRead(IGrantable identity) (experimental) Grant the given identity read permissions for this state machine.
Grant	grantStartExecution(IGrantable identity) (experimental) Grant the given identity permissions to start an execution of this state machine.
Grant	grantTaskResponse(IGrantable identity) (experimental) Grant the given identity read permissions for this state machine.
Metric	metric(String metricName) (experimental) Return the given named metric for this State Machine's executions.
Metric	metric(String metricName, MetricOptions props) (experimental) Return the given named metric for this State Machine's executions.
Metric	metricAborted() (experimental) Metric for the number of executions that were aborted.
Metric	metricAborted(MetricOptions props) (experimental) Metric for the number of executions that were aborted.
Metric	metricFailed() (experimental) Metric for the number of executions that failed.
Metric	metricFailed(MetricOptions props) (experimental) Metric for the number of executions that failed.
Metric	metricStarted() (experimental) Metric for the number of executions that were started.
Metric	metricStarted(MetricOptions props) (experimental) Metric for the number of executions that were started.
Metric	metricSucceeded() (experimental) Metric for the number of executions that succeeded.
Metric	metricSucceeded(MetricOptions props) (experimental) Metric for the number of executions that succeeded.
Metric	metricThrottled() (experimental) Metric for the number of executions that were throttled.
Metric	metricThrottled(MetricOptions props) (experimental) Metric for the number of executions that were throttled.
Metric	metricTime() (experimental) Metric for the interval, in milliseconds, between the time the execution starts and the time it closes.
Metric	metricTime(MetricOptions props) (experimental) Metric for the interval, in milliseconds, between the time the execution starts and the time it closes.
Metric	metricTimedOut() (experimental) Metric for the number of executions that timed out.
Metric	metricTimedOut(MetricOptions props) (experimental) Metric for the number of executions that timed out.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
public final software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IStateMachine.Jsii$Default

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

getEnv

@Stability(value=Experimental)
 @NotNull
public final ResourceEnvironment getEnv()

(experimental) The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface IStateMachine.Jsii$Default

getStack

@Stability(value=Experimental)
 @NotNull
public final Stack getStack()

(experimental) The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IStateMachine.Jsii$Default

getGrantPrincipal

@Stability(value=Experimental)
 @NotNull
public final IPrincipal getGrantPrincipal()

(experimental) The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in interface IGrantable.Jsii$Default

Specified by:

getGrantPrincipal in interface IStateMachine.Jsii$Default

getStateMachineArn

@Stability(value=Experimental)
 @NotNull
public final String getStateMachineArn()

(experimental) The ARN of the state machine.

Specified by:

getStateMachineArn in interface IStateMachine

Specified by:

getStateMachineArn in interface IStateMachine.Jsii$Default

grant

@Stability(value=Experimental)
 @NotNull
public final Grant grant(@NotNull
                                                                  IGrantable identity,
                                                                  @NotNull
                                                                  String... actions)

(experimental) Grant the given identity custom permissions.

Specified by:

grant in interface IStateMachine

Specified by:

grant in interface IStateMachine.Jsii$Default

Parameters:

identity - The principal. This parameter is required.

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

grantExecution

@Stability(value=Experimental)
 @NotNull
public final Grant grantExecution(@NotNull
                                                                           IGrantable identity,
                                                                           @NotNull
                                                                           String... actions)

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

Specified by:

grantExecution in interface IStateMachine

Specified by:

grantExecution in interface IStateMachine.Jsii$Default

Parameters:

identity - The principal. This parameter is required.

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

grantRead

@Stability(value=Experimental)
 @NotNull
public final Grant grantRead(@NotNull
                                                                      IGrantable identity)

(experimental) Grant the given identity read permissions for this state machine.

Specified by:

grantRead in interface IStateMachine

Specified by:

grantRead in interface IStateMachine.Jsii$Default

Parameters:

identity - The principal. This parameter is required.

grantStartExecution

@Stability(value=Experimental)
 @NotNull
public final Grant grantStartExecution(@NotNull
                                                                                IGrantable identity)

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

Specified by:

grantStartExecution in interface IStateMachine

Specified by:

grantStartExecution in interface IStateMachine.Jsii$Default

Parameters:

identity - The principal. This parameter is required.

grantTaskResponse

@Stability(value=Experimental)
 @NotNull
public final Grant grantTaskResponse(@NotNull
                                                                              IGrantable identity)

(experimental) Grant the given identity read permissions for this state machine.

Specified by:

grantTaskResponse in interface IStateMachine

Specified by:

grantTaskResponse in interface IStateMachine.Jsii$Default

Parameters:

identity - The principal. This parameter is required.

metric

@Stability(value=Experimental)
 @NotNull
public final Metric metric(@NotNull
                                                                    String metricName,
                                                                    @Nullable
                                                                    MetricOptions props)

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

Default: - sum over 5 minutes

Specified by:

metric in interface IStateMachine

Specified by:

metric in interface IStateMachine.Jsii$Default

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(value=Experimental)
 @NotNull
public final Metric metric(@NotNull
                                                                    String metricName)

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

Default: - sum over 5 minutes

Specified by:

metric in interface IStateMachine

Parameters:

metricName - This parameter is required.

metricAborted

@Stability(value=Experimental)
 @NotNull
public final Metric metricAborted(@Nullable
                                                                           MetricOptions props)

(experimental) Metric for the number of executions that were aborted.

Default: - sum over 5 minutes

Specified by:

metricAborted in interface IStateMachine

Specified by:

metricAborted in interface IStateMachine.Jsii$Default

Parameters:

props -

metricAborted

@Stability(value=Experimental)
 @NotNull
public final Metric metricAborted()

(experimental) Metric for the number of executions that were aborted.

Default: - sum over 5 minutes

Specified by:

metricAborted in interface IStateMachine

metricFailed

@Stability(value=Experimental)
 @NotNull
public final Metric metricFailed(@Nullable
                                                                          MetricOptions props)

(experimental) Metric for the number of executions that failed.

Default: - sum over 5 minutes

Specified by:

metricFailed in interface IStateMachine

Specified by:

metricFailed in interface IStateMachine.Jsii$Default

Parameters:

props -

metricFailed

@Stability(value=Experimental)
 @NotNull
public final Metric metricFailed()

(experimental) Metric for the number of executions that failed.

Default: - sum over 5 minutes

Specified by:

metricFailed in interface IStateMachine

metricStarted

@Stability(value=Experimental)
 @NotNull
public final Metric metricStarted(@Nullable
                                                                           MetricOptions props)

(experimental) Metric for the number of executions that were started.

Default: - sum over 5 minutes

Specified by:

metricStarted in interface IStateMachine

Specified by:

metricStarted in interface IStateMachine.Jsii$Default

Parameters:

props -

metricStarted

@Stability(value=Experimental)
 @NotNull
public final Metric metricStarted()

(experimental) Metric for the number of executions that were started.

Default: - sum over 5 minutes

Specified by:

metricStarted in interface IStateMachine

metricSucceeded

@Stability(value=Experimental)
 @NotNull
public final Metric metricSucceeded(@Nullable
                                                                             MetricOptions props)

(experimental) Metric for the number of executions that succeeded.

Default: - sum over 5 minutes

Specified by:

metricSucceeded in interface IStateMachine

Specified by:

metricSucceeded in interface IStateMachine.Jsii$Default

Parameters:

props -

metricSucceeded

@Stability(value=Experimental)
 @NotNull
public final Metric metricSucceeded()

(experimental) Metric for the number of executions that succeeded.

Default: - sum over 5 minutes

Specified by:

metricSucceeded in interface IStateMachine

metricThrottled

@Stability(value=Experimental)
 @NotNull
public final Metric metricThrottled(@Nullable
                                                                             MetricOptions props)

(experimental) Metric for the number of executions that were throttled.

Default: sum over 5 minutes

Specified by:

metricThrottled in interface IStateMachine

Specified by:

metricThrottled in interface IStateMachine.Jsii$Default

Parameters:

props -

metricThrottled

@Stability(value=Experimental)
 @NotNull
public final Metric metricThrottled()

(experimental) Metric for the number of executions that were throttled.

Default: sum over 5 minutes

Specified by:

metricThrottled in interface IStateMachine

metricTime

@Stability(value=Experimental)
 @NotNull
public final Metric metricTime(@Nullable
                                                                        MetricOptions props)

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

Default: - sum over 5 minutes

Specified by:

metricTime in interface IStateMachine

Specified by:

metricTime in interface IStateMachine.Jsii$Default

Parameters:

props -

metricTime

@Stability(value=Experimental)
 @NotNull
public final Metric metricTime()

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

Default: - sum over 5 minutes

Specified by:

metricTime in interface IStateMachine

metricTimedOut

@Stability(value=Experimental)
 @NotNull
public final Metric metricTimedOut(@Nullable
                                                                            MetricOptions props)

(experimental) Metric for the number of executions that timed out.

Default: - sum over 5 minutes

Specified by:

metricTimedOut in interface IStateMachine

Specified by:

metricTimedOut in interface IStateMachine.Jsii$Default

Parameters:

props -

metricTimedOut

@Stability(value=Experimental)
 @NotNull
public final Metric metricTimedOut()

(experimental) Metric for the number of executions that timed out.

Default: - sum over 5 minutes

Specified by:

metricTimedOut in interface IStateMachine