IStateMachine Interface
A State Machine.
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#The environment this resource belongs to.
notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipalrequired#The principal to grant permissions to.
The stack in which this resource is defined.
stateMachineArnstringstate_machine_arnstrstateMachineArnStringStateMachineArnstringStateMachineArn*stringrequired#The ARN of the state machine.
stateMachineRefStateMachineReferencestate_machine_refStateMachineReferencestateMachineRefStateMachineReferenceStateMachineRefStateMachineReferenceStateMachineRefStateMachineReferencerequired#A reference to a StateMachine resource.
Methods
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
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).
grant(identity: IGrantable, ...actions: string[]): Grantdef grant(self, identity: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable identity, String actions)public Grant Grant(IGrantable identity, string actions)func Grant(Identity IGrantable, Actions *string) Grant#Grant the given identity custom permissions.
2 parameters
Parameters
identityidentityidentityidentityIdentity— The principal.actionsactionsactionsactionsActions— The list of desired actions.
grantExecution(identity: IGrantable, ...actions: string[]): Grantdef grant_execution(self, identity: IGrantable, actions: str) -> Grantpublic Grant grantExecution(IGrantable identity, String actions)public Grant GrantExecution(IGrantable identity, string actions)func GrantExecution(Identity IGrantable, Actions *string) Grant#Grant the given identity permissions for all executions of a state machine.
2 parameters
Parameters
identityidentityidentityidentityIdentity— The principal.actionsactionsactionsactionsActions— The list of desired actions.
grantRead(identity: IGrantable): Grantdef grant_read(self, identity: IGrantable) -> Grantpublic Grant grantRead(IGrantable identity)public Grant GrantRead(IGrantable identity)func GrantRead(Identity IGrantable) Grant#Grant the given identity read permissions for this state machine.
1 parameter
Parameters
identityidentityidentityidentityIdentity— The principal.
grantRedriveExecution(identity: IGrantable): Grantdef grant_redrive_execution(self, identity: IGrantable) -> Grantpublic Grant grantRedriveExecution(IGrantable identity)public Grant GrantRedriveExecution(IGrantable identity)func GrantRedriveExecution(Identity IGrantable) Grant#Grant the given identity permission to redrive the execution of the state machine.
1 parameter
Parameters
identityidentityidentityidentityIdentity— The principal.
grantStartExecution(identity: IGrantable): Grantdef grant_start_execution(self, identity: IGrantable) -> Grantpublic Grant grantStartExecution(IGrantable identity)public Grant GrantStartExecution(IGrantable identity)func GrantStartExecution(Identity IGrantable) Grant#Grant the given identity permissions to start an execution of this state machine.
1 parameter
Parameters
identityidentityidentityidentityIdentity— The principal.
grantStartSyncExecution(identity: IGrantable): Grantdef grant_start_sync_execution(self, identity: IGrantable) -> Grantpublic Grant grantStartSyncExecution(IGrantable identity)public Grant GrantStartSyncExecution(IGrantable identity)func GrantStartSyncExecution(Identity IGrantable) Grant#Grant the given identity permissions to start a synchronous execution of this state machine.
1 parameter
Parameters
identityidentityidentityidentityIdentity— The principal.
grantTaskResponse(identity: IGrantable): Grantdef grant_task_response(self, identity: IGrantable) -> Grantpublic Grant grantTaskResponse(IGrantable identity)public Grant GrantTaskResponse(IGrantable identity)func GrantTaskResponse(Identity IGrantable) Grant#Grant the given identity read permissions for this state machine.
1 parameter
Parameters
identityidentityidentityidentityIdentity— The principal.
metric(metricName: string, props?: MetricOptions): Metricdef metric(self, metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, MetricOptions props)public Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *string, Props MetricOptions) Metric#Return the given named metric for this State Machine's executions.
metricAborted(props?: MetricOptions): Metricdef metric_aborted(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricAborted(MetricOptions props)public Metric MetricAborted(MetricOptions? props = null)func MetricAborted(Props MetricOptions) Metric#Metric for the number of executions that were aborted.
metricFailed(props?: MetricOptions): Metricdef metric_failed(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricFailed(MetricOptions props)public Metric MetricFailed(MetricOptions? props = null)func MetricFailed(Props MetricOptions) Metric#Metric for the number of executions that failed.
metricStarted(props?: MetricOptions): Metricdef metric_started(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricStarted(MetricOptions props)public Metric MetricStarted(MetricOptions? props = null)func MetricStarted(Props MetricOptions) Metric#Metric for the number of executions that were started.
metricSucceeded(props?: MetricOptions): Metricdef metric_succeeded(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSucceeded(MetricOptions props)public Metric MetricSucceeded(MetricOptions? props = null)func MetricSucceeded(Props MetricOptions) Metric#Metric for the number of executions that succeeded.
metricThrottled(props?: MetricOptions): Metricdef metric_throttled(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricThrottled(MetricOptions props)public Metric MetricThrottled(MetricOptions? props = null)func MetricThrottled(Props MetricOptions) Metric#Metric for the number of executions that were throttled.
metricTime(props?: MetricOptions): Metricdef metric_time(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricTime(MetricOptions props)public Metric MetricTime(MetricOptions? props = null)func MetricTime(Props MetricOptions) Metric#Metric for the interval, in milliseconds, between the time the execution starts and the time it closes.
metricTimedOut(props?: MetricOptions): Metricdef metric_timed_out(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricTimedOut(MetricOptions props)public Metric MetricTimedOut(MetricOptions? props = null)func MetricTimedOut(Props MetricOptions) Metric#Metric for the number of executions that timed out.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining