IStateMachine.Jsii$Default

All Superinterfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IGrantable, IGrantable.Jsii$Default, IResource, IResource.Jsii$Default, IStateMachine

All Known Implementing Classes:

IStateMachine.Jsii$Proxy

Enclosing interface:

IStateMachine
```
public static interface IStateMachine.Jsii$Default
extends IStateMachine, IResource.Jsii$Default, IGrantable.Jsii$Default
```
Internal default implementation for IStateMachine.

Nested Class Summary
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IStateMachine
  IStateMachine.Jsii$Default, IStateMachine.Jsii$Proxy

Method Summary

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

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.IStateMachine
metric, metricAborted, metricFailed, metricStarted, metricSucceeded, metricThrottled, metricTime, metricTimedOut

- Method Detail
  - getNode
```
default 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
  - getEnv
```
default 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
  - getStack
```
default Stack getStack()
```
    The stack in which this resource is defined.
    
    Specified by:
    
    getStack in interface IResource
    
    Specified by:
    
    getStack in interface IResource.Jsii$Default
  - getGrantPrincipal
```
default IPrincipal getGrantPrincipal()
```
    The principal to grant permissions to.
    
    Specified by:
    
    getGrantPrincipal in interface IGrantable
    
    Specified by:
    
    getGrantPrincipal in interface IGrantable.Jsii$Default
  - getStateMachineArn
```
default java.lang.String getStateMachineArn()
```
    The ARN of the state machine.
    
    Specified by:
    
    getStateMachineArn in interface IStateMachine
  - applyRemovalPolicy
```
default 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
    
    Parameters:
    
    policy - This parameter is required.
  - grant
```
default Grant grant(IGrantable identity,
                    java.lang.String... actions)
```
    Grant the given identity custom permissions.
    
    Specified by:
    
    grant in interface IStateMachine
    
    Parameters:
    
    identity - The principal. This parameter is required.
    
    actions - The list of desired actions. This parameter is required.
  - grantExecution
```
default 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
    
    Parameters:
    
    identity - The principal. This parameter is required.
    
    actions - The list of desired actions. This parameter is required.
  - grantRead
```
default Grant grantRead(IGrantable identity)
```
    Grant the given identity read permissions for this state machine.
    
    Specified by:
    
    grantRead in interface IStateMachine
    
    Parameters:
    
    identity - The principal. This parameter is required.
  - grantStartExecution
```
default Grant grantStartExecution(IGrantable identity)
```
    Grant the given identity permissions to start an execution of this state machine.
    
    Specified by:
    
    grantStartExecution in interface IStateMachine
    
    Parameters:
    
    identity - The principal. This parameter is required.
  - grantStartSyncExecution
```
default Grant grantStartSyncExecution(IGrantable identity)
```
    Grant the given identity permissions to start a synchronous execution of this state machine.
    
    Specified by:
    
    grantStartSyncExecution in interface IStateMachine
    
    Parameters:
    
    identity - The principal. This parameter is required.
  - grantTaskResponse
```
default Grant grantTaskResponse(IGrantable identity)
```
    Grant the given identity read permissions for this state machine.
    
    Specified by:
    
    grantTaskResponse in interface IStateMachine
    
    Parameters:
    
    identity - The principal. This parameter is required.
  - metric
```
default 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
    
    Parameters:
    
    metricName - This parameter is required.
    
    props -
  - metricAborted
```
default Metric metricAborted(MetricOptions props)
```
    Metric for the number of executions that were aborted.
    Default: - sum over 5 minutes
    
    Specified by:
    
    metricAborted in interface IStateMachine
    
    Parameters:
    
    props -
  - metricFailed
```
default Metric metricFailed(MetricOptions props)
```
    Metric for the number of executions that failed.
    Default: - sum over 5 minutes
    
    Specified by:
    
    metricFailed in interface IStateMachine
    
    Parameters:
    
    props -
  - metricStarted
```
default Metric metricStarted(MetricOptions props)
```
    Metric for the number of executions that were started.
    Default: - sum over 5 minutes
    
    Specified by:
    
    metricStarted in interface IStateMachine
    
    Parameters:
    
    props -
  - metricSucceeded
```
default Metric metricSucceeded(MetricOptions props)
```
    Metric for the number of executions that succeeded.
    Default: - sum over 5 minutes
    
    Specified by:
    
    metricSucceeded in interface IStateMachine
    
    Parameters:
    
    props -
  - metricThrottled
```
default Metric metricThrottled(MetricOptions props)
```
    Metric for the number of executions that were throttled.
    Default: sum over 5 minutes
    
    Specified by:
    
    metricThrottled in interface IStateMachine
    
    Parameters:
    
    props -
  - metricTime
```
default 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
    
    Parameters:
    
    props -
  - metricTimedOut
```
default Metric metricTimedOut(MetricOptions props)
```
    Metric for the number of executions that timed out.
    Default: - sum over 5 minutes
    
    Specified by:
    
    metricTimedOut in interface IStateMachine
    
    Parameters:
    
    props -

Interface IStateMachine.Jsii$Default

Nested Class Summary

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

Method Summary

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.IStateMachine

Method Detail

getNode

getEnv

getStack

getGrantPrincipal

getStateMachineArn

applyRemovalPolicy

grant

grantExecution

grantRead

grantStartExecution

grantStartSyncExecution

grantTaskResponse

metric

metricAborted

metricFailed

metricStarted

metricSucceeded

metricThrottled

metricTime

metricTimedOut