Package 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:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IGrantable, IGrantable.Jsii$Default, IStateMachine, IStateMachine.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.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.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IDependable

IDependable.Jsii$Default, IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGrantable

IGrantable.Jsii$Default, IGrantable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

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

IStateMachine.Jsii$Default, IStateMachine.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
final ResourceEnvironment	getEnv()	The environment this resource belongs to.
final IPrincipal	getGrantPrincipal()	The principal to grant permissions to.
final ConstructNode	getNode()	The construct tree node for this construct.
final Stack	getStack()	The stack in which this resource is defined.
final String	getStateMachineArn()	The ARN of the state machine.
final Grant	grant(IGrantable identity, @NotNull String... actions)	Grant the given identity custom permissions.
final Grant	grantExecution(IGrantable identity, @NotNull String... actions)	Grant the given identity permissions for all executions of a state machine.
final Grant	grantRead(IGrantable identity)	Grant the given identity read permissions for this state machine.
final Grant	grantStartExecution(IGrantable identity)	Grant the given identity permissions to start an execution of this state machine.
final Grant	grantStartSyncExecution(IGrantable identity)	Grant the given identity permissions to start a synchronous execution of this state machine.
final Grant	grantTaskResponse(IGrantable identity)	Grant the given identity read permissions for this state machine.
final Metric	metric(String metricName)	Return the given named metric for this State Machine's executions.
final Metric	metric(String metricName, MetricOptions props)	Return the given named metric for this State Machine's executions.
final Metric	metricAborted()	Metric for the number of executions that were aborted.
final Metric	metricAborted(MetricOptions props)	Metric for the number of executions that were aborted.
final Metric	metricFailed()	Metric for the number of executions that failed.
final Metric	metricFailed(MetricOptions props)	Metric for the number of executions that failed.
final Metric	metricStarted()	Metric for the number of executions that were started.
final Metric	metricStarted(MetricOptions props)	Metric for the number of executions that were started.
final Metric	metricSucceeded()	Metric for the number of executions that succeeded.
final Metric	metricSucceeded(MetricOptions props)	Metric for the number of executions that succeeded.
final Metric	metricThrottled()	Metric for the number of executions that were throttled.
final Metric	metricThrottled(MetricOptions props)	Metric for the number of executions that were throttled.
final Metric	metricTime()	Metric for the interval, in milliseconds, between the time the execution starts and the time it closes.
final Metric	metricTime(MetricOptions props)	Metric for the interval, in milliseconds, between the time the execution starts and the time it closes.
final Metric	metricTimedOut()	Metric for the number of executions that timed out.
final Metric	metricTimedOut(MetricOptions props)	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 Details

Jsii$Proxy

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

Method Details

getNode

@Stability(Stable)
@NotNull
public final ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IStateMachine.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
public final ResourceEnvironment getEnv()

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(Stable)
@NotNull
public final Stack getStack()

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(Stable)
@NotNull
public final IPrincipal getGrantPrincipal()

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(Stable)
@NotNull
public final String getStateMachineArn()

The ARN of the state machine.

Specified by:

getStateMachineArn in interface IStateMachine

Specified by:

getStateMachineArn in interface IStateMachine.Jsii$Default

applyRemovalPolicy

@Stability(Stable)
public final void applyRemovalPolicy(@NotNull
 RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Specified by:

applyRemovalPolicy in interface IStateMachine.Jsii$Default

Parameters:

policy - This parameter is required.

grant

@Stability(Stable)
@NotNull
public final Grant grant(@NotNull
 IGrantable identity,
 @NotNull
 @NotNull String... actions)

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(Stable)
@NotNull
public final Grant grantExecution(@NotNull
 IGrantable identity,
 @NotNull
 @NotNull String... actions)

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(Stable)
@NotNull
public final Grant grantRead(@NotNull
 IGrantable identity)

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(Stable)
@NotNull
public final Grant grantStartExecution(@NotNull
 IGrantable identity)

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.

grantStartSyncExecution

@Stability(Stable)
@NotNull
public final Grant grantStartSyncExecution(@NotNull
 IGrantable identity)

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

Specified by:

grantStartSyncExecution in interface IStateMachine

Specified by:

grantStartSyncExecution in interface IStateMachine.Jsii$Default

Parameters:

identity - The principal. This parameter is required.

grantTaskResponse

@Stability(Stable)
@NotNull
public final Grant grantTaskResponse(@NotNull
 IGrantable identity)

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(Stable)
@NotNull
public final Metric metric(@NotNull
 String metricName,
 @Nullable
 MetricOptions props)

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(Stable)
@NotNull
public final Metric metric(@NotNull
 String metricName)

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(Stable)
@NotNull
public final Metric metricAborted(@Nullable
 MetricOptions props)

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(Stable)
@NotNull
public final Metric metricAborted()

Metric for the number of executions that were aborted.

Default: - sum over 5 minutes

Specified by:

metricAborted in interface IStateMachine

metricFailed

@Stability(Stable)
@NotNull
public final Metric metricFailed(@Nullable
 MetricOptions props)

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(Stable)
@NotNull
public final Metric metricFailed()

Metric for the number of executions that failed.

Default: - sum over 5 minutes

Specified by:

metricFailed in interface IStateMachine

metricStarted

@Stability(Stable)
@NotNull
public final Metric metricStarted(@Nullable
 MetricOptions props)

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(Stable)
@NotNull
public final Metric metricStarted()

Metric for the number of executions that were started.

Default: - sum over 5 minutes

Specified by:

metricStarted in interface IStateMachine

metricSucceeded

@Stability(Stable)
@NotNull
public final Metric metricSucceeded(@Nullable
 MetricOptions props)

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(Stable)
@NotNull
public final Metric metricSucceeded()

Metric for the number of executions that succeeded.

Default: - sum over 5 minutes

Specified by:

metricSucceeded in interface IStateMachine

metricThrottled

@Stability(Stable)
@NotNull
public final Metric metricThrottled(@Nullable
 MetricOptions props)

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(Stable)
@NotNull
public final Metric metricThrottled()

Metric for the number of executions that were throttled.

Default: sum over 5 minutes

Specified by:

metricThrottled in interface IStateMachine

metricTime

@Stability(Stable)
@NotNull
public final Metric metricTime(@Nullable
 MetricOptions props)

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(Stable)
@NotNull
public final Metric metricTime()

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(Stable)
@NotNull
public final Metric metricTimedOut(@Nullable
 MetricOptions props)

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(Stable)
@NotNull
public final Metric metricTimedOut()

Metric for the number of executions that timed out.

Default: - sum over 5 minutes

Specified by:

metricTimedOut in interface IStateMachine