CfnMapRunPropsMixin

class aws_cdk.cfn_property_mixins.aws_stepfunctions.CfnMapRunPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource schema for AWS::StepFunctions::MapRun.

A Map Run is a set of child workflow executions started by a Distributed Map state in Step Functions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-maprun.html
CloudformationResource:: AWS::StepFunctions::MapRun
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_stepfunctions as stepfunctions
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_map_run_props_mixin = stepfunctions.CfnMapRunPropsMixin(stepfunctions.CfnMapRunMixinProps(
    execution_arn="executionArn"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::StepFunctions::MapRun.

Parameters:

props (Union[CfnMapRunMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['executionArn']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

MapRunExecutionCountsProperty

class CfnMapRunPropsMixin.MapRunExecutionCountsProperty(*, aborted=None, failed=None, failures_not_redrivable=None, pending=None, pending_redrive=None, results_written=None, running=None, succeeded=None, timed_out=None, total=None)

Bases: object

Contains details about all child workflow executions started by a Map Run.

Parameters:

aborted (Union[int, float, None]) – The total number of child workflow executions that were stopped.
failed (Union[int, float, None]) – The total number of child workflow executions that have failed.
failures_not_redrivable (Union[int, float, None]) – The number of child workflow executions that cannot be redriven.
pending (Union[int, float, None]) – The total number of child workflow executions that haven’t started executing yet.
pending_redrive (Union[int, float, None]) – The number of unsuccessful child workflow executions waiting to be redriven.
results_written (Union[int, float, None]) – The count of child workflow executions whose results were written by ResultWriter.
running (Union[int, float, None]) – The total number of child workflow executions that are currently in-progress.
succeeded (Union[int, float, None]) – The total number of child workflow executions that have completed successfully.
timed_out (Union[int, float, None]) – The total number of child workflow executions that have timed out.
total (Union[int, float, None]) – The total number of child workflow executions started by a Map Run.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunexecutioncounts.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_stepfunctions as stepfunctions

map_run_execution_counts_property = stepfunctions.CfnMapRunPropsMixin.MapRunExecutionCountsProperty(
    aborted=123,
    failed=123,
    failures_not_redrivable=123,
    pending=123,
    pending_redrive=123,
    results_written=123,
    running=123,
    succeeded=123,
    timed_out=123,
    total=123
)

Attributes

aborted

The total number of child workflow executions that were stopped.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunexecutioncounts.html#cfn-stepfunctions-maprun-maprunexecutioncounts-aborted

failed

The total number of child workflow executions that have failed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunexecutioncounts.html#cfn-stepfunctions-maprun-maprunexecutioncounts-failed

failures_not_redrivable

The number of child workflow executions that cannot be redriven.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunexecutioncounts.html#cfn-stepfunctions-maprun-maprunexecutioncounts-failuresnotredrivable

pending

The total number of child workflow executions that haven’t started executing yet.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunexecutioncounts.html#cfn-stepfunctions-maprun-maprunexecutioncounts-pending

pending_redrive

The number of unsuccessful child workflow executions waiting to be redriven.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunexecutioncounts.html#cfn-stepfunctions-maprun-maprunexecutioncounts-pendingredrive

results_written

The count of child workflow executions whose results were written by ResultWriter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunexecutioncounts.html#cfn-stepfunctions-maprun-maprunexecutioncounts-resultswritten

running

The total number of child workflow executions that are currently in-progress.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunexecutioncounts.html#cfn-stepfunctions-maprun-maprunexecutioncounts-running

succeeded

The total number of child workflow executions that have completed successfully.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunexecutioncounts.html#cfn-stepfunctions-maprun-maprunexecutioncounts-succeeded

timed_out

The total number of child workflow executions that have timed out.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunexecutioncounts.html#cfn-stepfunctions-maprun-maprunexecutioncounts-timedout

total

The total number of child workflow executions started by a Map Run.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunexecutioncounts.html#cfn-stepfunctions-maprun-maprunexecutioncounts-total

MapRunItemCountsProperty

class CfnMapRunPropsMixin.MapRunItemCountsProperty(*, aborted=None, failed=None, failures_not_redrivable=None, pending=None, pending_redrive=None, results_written=None, running=None, succeeded=None, timed_out=None, total=None)

Bases: object

Contains details about items processed in all child workflow executions started by a Map Run.

Parameters:

aborted (Union[int, float, None]) – The total number of items processed in child workflow executions that were stopped.
failed (Union[int, float, None]) – The total number of items processed in child workflow executions that have failed.
failures_not_redrivable (Union[int, float, None]) – The number of items in child workflow executions that cannot be redriven.
pending (Union[int, float, None]) – The total number of items to process in child workflow executions that haven’t started running yet.
pending_redrive (Union[int, float, None]) – The number of unsuccessful items currently waiting to be redriven.
results_written (Union[int, float, None]) – The count of items whose results were written by ResultWriter.
running (Union[int, float, None]) – The total number of items being processed in child workflow executions that are currently in-progress.
succeeded (Union[int, float, None]) – The total number of items processed in child workflow executions that have completed successfully.
timed_out (Union[int, float, None]) – The total number of items processed in child workflow executions that have timed out.
total (Union[int, float, None]) – The total number of items processed in all the child workflow executions started by a Map Run.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunitemcounts.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_stepfunctions as stepfunctions

map_run_item_counts_property = stepfunctions.CfnMapRunPropsMixin.MapRunItemCountsProperty(
    aborted=123,
    failed=123,
    failures_not_redrivable=123,
    pending=123,
    pending_redrive=123,
    results_written=123,
    running=123,
    succeeded=123,
    timed_out=123,
    total=123
)

Attributes

aborted

The total number of items processed in child workflow executions that were stopped.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunitemcounts.html#cfn-stepfunctions-maprun-maprunitemcounts-aborted

failed

The total number of items processed in child workflow executions that have failed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunitemcounts.html#cfn-stepfunctions-maprun-maprunitemcounts-failed

failures_not_redrivable

The number of items in child workflow executions that cannot be redriven.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunitemcounts.html#cfn-stepfunctions-maprun-maprunitemcounts-failuresnotredrivable

pending

The total number of items to process in child workflow executions that haven’t started running yet.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunitemcounts.html#cfn-stepfunctions-maprun-maprunitemcounts-pending

pending_redrive

The number of unsuccessful items currently waiting to be redriven.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunitemcounts.html#cfn-stepfunctions-maprun-maprunitemcounts-pendingredrive

results_written

The count of items whose results were written by ResultWriter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunitemcounts.html#cfn-stepfunctions-maprun-maprunitemcounts-resultswritten

running

The total number of items being processed in child workflow executions that are currently in-progress.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunitemcounts.html#cfn-stepfunctions-maprun-maprunitemcounts-running

succeeded

The total number of items processed in child workflow executions that have completed successfully.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunitemcounts.html#cfn-stepfunctions-maprun-maprunitemcounts-succeeded

timed_out

The total number of items processed in child workflow executions that have timed out.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunitemcounts.html#cfn-stepfunctions-maprun-maprunitemcounts-timedout

total

The total number of items processed in all the child workflow executions started by a Map Run.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-maprun-maprunitemcounts.html#cfn-stepfunctions-maprun-maprunitemcounts-total