EmrModifyInstanceGroupByName¶

class aws_cdk.aws_stepfunctions_tasks.EmrModifyInstanceGroupByName(scope, id, *, cluster_id, instance_group, instance_group_name, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, timeout=None)¶

Bases: aws_cdk.aws_stepfunctions.TaskStateBase

(experimental) A Step Functions Task to to modify an InstanceGroup on an EMR Cluster.

Stability

experimental

Parameters

scope (Construct) –
id (str) –
cluster_id (str) – (experimental) The ClusterId to update.
instance_group (InstanceGroupModifyConfigProperty) – (experimental) The JSON that you want to provide to your ModifyInstanceGroup call as input. This uses the same syntax as the ModifyInstanceGroups API.
instance_group_name (str) – (experimental) The InstanceGroupName to update.
comment (Optional[str]) – An optional description for this state. Default: - No comment
heartbeat (Optional[Duration]) – Timeout for the heartbeat. Default: - None
input_path (Optional[str]) – JSONPath expression to select part of the state to be the input to this state. May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}. Default: - The entire task input (JSON path ‘$’)
integration_pattern (Optional[IntegrationPattern]) – AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns Default: IntegrationPattern.REQUEST_RESPONSE
output_path (Optional[str]) – JSONPath expression to select select a portion of the state output to pass to the next state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}. Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path ‘$’)
result_path (Optional[str]) – JSONPath expression to indicate where to inject the state’s output. May also be the special value JsonPath.DISCARD, which will cause the state’s input to become its output. Default: - Replaces the entire input with the result (JSON path ‘$’)
timeout (Optional[Duration]) – Timeout for the state machine. Default: - None

Stability

experimental

Methods

add_catch(handler, *, errors=None, result_path=None)¶

Add a recovery handler for this state.

When a particular error occurs, execution will continue at the error handler instead of failing the state machine execution.

Parameters

handler (IChainable) –
errors (Optional[List[str]]) – Errors to recover from by going to the given state. A list of error strings to retry, which can be either predefined errors (for example Errors.NoChoiceMatched) or a self-defined error. Default: All errors
result_path (Optional[str]) – JSONPath expression to indicate where to inject the error data. May also be the special value DISCARD, which will cause the error data to be discarded. Default: $

Return type

TaskStateBase

add_prefix(x)¶

Add a prefix to the stateId of this state.

Parameters

x (str) –

Return type

None

add_retry(*, backoff_rate=None, errors=None, interval=None, max_attempts=None)¶

Add retry configuration for this state.

This controls if and how the execution will be retried if a particular error occurs.

Parameters

backoff_rate (Union[int, float, None]) – Multiplication for how much longer the wait interval gets on every retry. Default: 2
errors (Optional[List[str]]) – Errors to retry. A list of error strings to retry, which can be either predefined errors (for example Errors.NoChoiceMatched) or a self-defined error. Default: All errors
interval (Optional[Duration]) – How many seconds to wait initially before retrying. Default: Duration.seconds(1)
max_attempts (Union[int, float, None]) – How many times to retry this particular error. May be 0 to disable retry for specific errors (in case you have a catch-all retry policy). Default: 3

Return type

TaskStateBase

bind_to_graph(graph)¶

Register this state as part of the given graph.

Don’t call this. It will be called automatically when you work with states normally.

Parameters

graph (StateGraph) –

Return type

None

metric(metric_name, *, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

Return the given named metric for this Task.

Parameters

metric_name (str) –
account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Default

sum over 5 minutes

Return type

Metric

metric_failed(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

Metric for the number of times this activity fails.

Parameters

account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Default

sum over 5 minutes

Return type

Metric

metric_heartbeat_timed_out(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

Metric for the number of times the heartbeat times out for this activity.

Parameters

account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Default

sum over 5 minutes

Return type

Metric

metric_run_time(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

The interval, in milliseconds, between the time the Task starts and the time it closes.

Parameters

account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Default

average over 5 minutes

Return type

Metric

metric_schedule_time(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

The interval, in milliseconds, for which the activity stays in the schedule state.

Parameters

account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Default

average over 5 minutes

Return type

Metric

metric_scheduled(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

Metric for the number of times this activity is scheduled.

Parameters

account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Default

sum over 5 minutes

Return type

Metric

metric_started(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

Metric for the number of times this activity is started.

Parameters

account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Default

sum over 5 minutes

Return type

Metric

metric_succeeded(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

Metric for the number of times this activity succeeds.

Parameters

account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Default

sum over 5 minutes

Return type

Metric

metric_time(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

The interval, in milliseconds, between the time the activity is scheduled and the time it closes.

Parameters

account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Default

average over 5 minutes

Return type

Metric

metric_timed_out(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

Metric for the number of times this activity times out.

Parameters

account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Default

sum over 5 minutes

Return type

Metric

next(next)¶

Continue normal execution with the given state.

Parameters

next (IChainable) –

Return type

Chain

to_state_json()¶

Return the Amazon States Language object for this state.

Return type: Mapping[Any, Any]

to_string()¶

Returns a string representation of this construct.

Return type: str

Attributes

end_states¶

Continuable states of this Chainable.

Return type: List[INextable]

id¶

Descriptive identifier for this chainable.

Return type: str

node¶

The construct tree node associated with this construct.

Return type: ConstructNode

start_state¶

First state of this Chainable.

Return type: State

state_id¶

Tokenized string that evaluates to the state’s ID.

Return type: str

Static Methods

classmethod filter_nextables(states)¶

Return only the states that allow chaining from an array of states.

Parameters

states (List[State]) –

Return type

List[INextable]

classmethod find_reachable_end_states(start, *, include_error_handlers=None)¶

Find the set of end states states reachable through transitions from the given start state.

Parameters

start (State) –
include_error_handlers (Optional[bool]) – Whether or not to follow error-handling transitions. Default: false

Return type

List[State]

classmethod find_reachable_states(start, *, include_error_handlers=None)¶

Find the set of states reachable through transitions from the given start state.

This does not retrieve states from within sub-graphs, such as states within a Parallel state’s branch.

Parameters

start (State) –
include_error_handlers (Optional[bool]) – Whether or not to follow error-handling transitions. Default: false

Return type

List[State]

classmethod is_construct(x)¶

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod prefix_states(root, prefix)¶

Add a prefix to the stateId of all States found in a construct tree.

Parameters

root (IConstruct) –
prefix (str) –

Return type

None

InstanceGroupModifyConfigProperty¶

class EmrModifyInstanceGroupByName.InstanceGroupModifyConfigProperty(*, configurations=None, e_c2_instance_ids_to_terminate=None, instance_count=None, shrink_policy=None)¶

Bases: object

(experimental) Modify the size or configurations of an instance group.

Parameters

configurations (Optional[List[ConfigurationProperty]]) – (experimental) A list of new or modified configurations to apply for an instance group. Default: - None
e_c2_instance_ids_to_terminate (Optional[List[str]]) – (experimental) The EC2 InstanceIds to terminate. After you terminate the instances, the instance group will not return to its original requested size. Default: - None
instance_count (Union[int, float, None]) – (experimental) Target size for the instance group. Default: - None
shrink_policy (Optional[ShrinkPolicyProperty]) – (experimental) Policy for customizing shrink operations. Default: - None

See

https://docs.aws.amazon.com/emr/latest/APIReference/API_InstanceGroupModifyConfig.html

Stability

experimental

Attributes

configurations¶

(experimental) A list of new or modified configurations to apply for an instance group.

Default

None

Stability

experimental

Return type

Optional[List[ConfigurationProperty]]

e_c2_instance_ids_to_terminate¶

(experimental) The EC2 InstanceIds to terminate.

After you terminate the instances, the instance group will not return to its original requested size.

Default

None

Stability

experimental

Return type

Optional[List[str]]

instance_count¶

(experimental) Target size for the instance group.

Default

None

Stability

experimental

Return type

Union[int, float, None]

shrink_policy¶

(experimental) Policy for customizing shrink operations.

Default

None

See

https://docs.aws.amazon.com/emr/latest/APIReference/API_ShrinkPolicy.html

Stability

experimental

Return type

Optional[ShrinkPolicyProperty]

InstanceResizePolicyProperty¶

class EmrModifyInstanceGroupByName.InstanceResizePolicyProperty(*, instances_to_protect=None, instances_to_terminate=None, instance_termination_timeout=None)¶

Bases: object

(experimental) Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.

Parameters

instances_to_protect (Optional[List[str]]) – (experimental) Specific list of instances to be protected when shrinking an instance group. Default: - No instances will be protected when shrinking an instance group
instances_to_terminate (Optional[List[str]]) – (experimental) Specific list of instances to be terminated when shrinking an instance group. Default: - No instances will be terminated when shrinking an instance group.
instance_termination_timeout (Optional[Duration]) – (experimental) Decommissioning timeout override for the specific list of instances to be terminated. Default: cdk.Duration.seconds

See

https://docs.aws.amazon.com/emr/latest/APIReference/API_InstanceResizePolicy.html

Stability

experimental

Attributes

instance_termination_timeout¶

(experimental) Decommissioning timeout override for the specific list of instances to be terminated.

Default: cdk.Duration.seconds
Stability: experimental
Return type: Optional[Duration]

instances_to_protect¶

(experimental) Specific list of instances to be protected when shrinking an instance group.

Default

No instances will be protected when shrinking an instance group

Stability

experimental

Return type

Optional[List[str]]

instances_to_terminate¶

(experimental) Specific list of instances to be terminated when shrinking an instance group.

Default

No instances will be terminated when shrinking an instance group.

Stability

experimental

Return type

Optional[List[str]]

ShrinkPolicyProperty¶

class EmrModifyInstanceGroupByName.ShrinkPolicyProperty(*, decommission_timeout=None, instance_resize_policy=None)¶

Bases: object

(experimental) Policy for customizing shrink operations.

Allows configuration of decommissioning timeout and targeted instance shrinking.

Parameters

decommission_timeout (Optional[Duration]) – (experimental) The desired timeout for decommissioning an instance. Overrides the default YARN decommissioning timeout. Default: - EMR selected default
instance_resize_policy (Optional[InstanceResizePolicyProperty]) – (experimental) Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group. Default: - None

See

https://docs.aws.amazon.com/emr/latest/APIReference/API_ShrinkPolicy.html

Stability

experimental

Attributes

decommission_timeout¶

(experimental) The desired timeout for decommissioning an instance.

Overrides the default YARN decommissioning timeout.

Default

EMR selected default

Stability

experimental

Return type

Optional[Duration]

instance_resize_policy¶

(experimental) Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.

Default

None

Stability

experimental

Return type

Optional[InstanceResizePolicyProperty]