public static interface IStateMachine.Jsii$Default extends IStateMachine, IResource.Jsii$Default, IGrantable.Jsii$Default
IStateMachine
.IStateMachine.Jsii$Default, IStateMachine.Jsii$Proxy
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.
|
metric, metricAborted, metricFailed, metricStarted, metricSucceeded, metricThrottled, metricTime, metricTimedOut
default ConstructNode getNode()
getNode
in interface IConstruct
getNode
in interface IConstruct.Jsii$Default
getNode
in interface IResource.Jsii$Default
default ResourceEnvironment getEnv()
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.
getEnv
in interface IResource
getEnv
in interface IResource.Jsii$Default
default Stack getStack()
getStack
in interface IResource
getStack
in interface IResource.Jsii$Default
default IPrincipal getGrantPrincipal()
getGrantPrincipal
in interface IGrantable
getGrantPrincipal
in interface IGrantable.Jsii$Default
default java.lang.String getStateMachineArn()
getStateMachineArn
in interface IStateMachine
default void applyRemovalPolicy(RemovalPolicy policy)
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
).
applyRemovalPolicy
in interface IResource
applyRemovalPolicy
in interface IResource.Jsii$Default
policy
- This parameter is required.default Grant grant(IGrantable identity, java.lang.String... actions)
grant
in interface IStateMachine
identity
- The principal. This parameter is required.actions
- The list of desired actions. This parameter is required.default Grant grantExecution(IGrantable identity, java.lang.String... actions)
grantExecution
in interface IStateMachine
identity
- The principal. This parameter is required.actions
- The list of desired actions. This parameter is required.default Grant grantRead(IGrantable identity)
grantRead
in interface IStateMachine
identity
- The principal. This parameter is required.default Grant grantStartExecution(IGrantable identity)
grantStartExecution
in interface IStateMachine
identity
- The principal. This parameter is required.default Grant grantStartSyncExecution(IGrantable identity)
grantStartSyncExecution
in interface IStateMachine
identity
- The principal. This parameter is required.default Grant grantTaskResponse(IGrantable identity)
grantTaskResponse
in interface IStateMachine
identity
- The principal. This parameter is required.default Metric metric(java.lang.String metricName, MetricOptions props)
Default: - sum over 5 minutes
metric
in interface IStateMachine
metricName
- This parameter is required.props
- default Metric metricAborted(MetricOptions props)
Default: - sum over 5 minutes
metricAborted
in interface IStateMachine
props
- default Metric metricFailed(MetricOptions props)
Default: - sum over 5 minutes
metricFailed
in interface IStateMachine
props
- default Metric metricStarted(MetricOptions props)
Default: - sum over 5 minutes
metricStarted
in interface IStateMachine
props
- default Metric metricSucceeded(MetricOptions props)
Default: - sum over 5 minutes
metricSucceeded
in interface IStateMachine
props
- default Metric metricThrottled(MetricOptions props)
Default: sum over 5 minutes
metricThrottled
in interface IStateMachine
props
- default Metric metricTime(MetricOptions props)
Default: - sum over 5 minutes
metricTime
in interface IStateMachine
props
- default Metric metricTimedOut(MetricOptions props)
Default: - sum over 5 minutes
metricTimedOut
in interface IStateMachine
props
-