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

Enclosing interface:

IStateMachine

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Jsii$Proxy

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

Method Detail

getNode

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

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

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

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

public final java.lang.String getStateMachineArn()

The ARN of the state machine.

Specified by:

getStateMachineArn in interface IStateMachine

Specified by:

getStateMachineArn in interface IStateMachine.Jsii$Default

applyRemovalPolicy

public final void applyRemovalPolicy(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

public final Grant grant(IGrantable identity,
                         java.lang.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

public final Grant grantExecution(IGrantable identity,
                                  java.lang.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

public final Grant grantRead(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

public final Grant grantStartExecution(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

public final Grant grantStartSyncExecution(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

public final Grant grantTaskResponse(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

public final Metric metric(java.lang.String metricName,
                           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

public final Metric metric(java.lang.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

public final Metric metricAborted(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

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

public final Metric metricFailed(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

public final Metric metricFailed()

Metric for the number of executions that failed.

Default: - sum over 5 minutes

Specified by:

metricFailed in interface IStateMachine

metricStarted

public final Metric metricStarted(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

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

public final Metric metricSucceeded(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

public final Metric metricSucceeded()

Metric for the number of executions that succeeded.

Default: - sum over 5 minutes

Specified by:

metricSucceeded in interface IStateMachine

metricThrottled

public final Metric metricThrottled(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

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

public final Metric metricTime(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

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

public final Metric metricTimedOut(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

public final Metric metricTimedOut()

Metric for the number of executions that timed out.

Default: - sum over 5 minutes

Specified by:

metricTimedOut in interface IStateMachine