Skip to content

/AWS1/CL_EMRSTEP

This represents a step in a cluster.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_id TYPE /AWS1/EMRSTEPID /AWS1/EMRSTEPID

The identifier of the cluster step.

iv_name TYPE /AWS1/EMRSTRING /AWS1/EMRSTRING

The name of the cluster step.

io_config TYPE REF TO /AWS1/CL_EMRHADOOPSTEPCONFIG /AWS1/CL_EMRHADOOPSTEPCONFIG

The Hadoop job configuration of the cluster step.

iv_actiononfailure TYPE /AWS1/EMRACTIONONFAILURE /AWS1/EMRACTIONONFAILURE

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.

If a cluster's StepConcurrencyLevel is greater than 1, do not use AddJobFlowSteps to submit a step with this parameter set to CANCEL_AND_WAIT or TERMINATE_CLUSTER. The step is not submitted and the action fails with a message that the ActionOnFailure setting is not valid.

If you change a cluster's StepConcurrencyLevel to be greater than 1 while a step is running, the ActionOnFailure parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_CLUSTER, the cluster does not terminate.

io_status TYPE REF TO /AWS1/CL_EMRSTEPSTATUS /AWS1/CL_EMRSTEPSTATUS

The current execution status details of the cluster step.

iv_executionrolearn TYPE /AWS1/EMROPTIONALARNTYPE /AWS1/EMROPTIONALARNTYPE

The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource.

For example, arn:aws:IAM::1234567890:role/ReadOnly is a correctly formatted runtime role ARN.

iv_loguri TYPE /AWS1/EMRSTRING /AWS1/EMRSTRING

The Amazon S3 destination URI for log publishing.

iv_encryptionkeyarn TYPE /AWS1/EMRSTRING /AWS1/EMRSTRING

The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.


Queryable Attributes

Id

The identifier of the cluster step.

Accessible with the following methods

Method Description
GET_ID() Getter for ID, with configurable default
ASK_ID() Getter for ID w/ exceptions if field has no value
HAS_ID() Determine if ID has a value

Name

The name of the cluster step.

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

Config

The Hadoop job configuration of the cluster step.

Accessible with the following methods

Method Description
GET_CONFIG() Getter for CONFIG

ActionOnFailure

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.

If a cluster's StepConcurrencyLevel is greater than 1, do not use AddJobFlowSteps to submit a step with this parameter set to CANCEL_AND_WAIT or TERMINATE_CLUSTER. The step is not submitted and the action fails with a message that the ActionOnFailure setting is not valid.

If you change a cluster's StepConcurrencyLevel to be greater than 1 while a step is running, the ActionOnFailure parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_CLUSTER, the cluster does not terminate.

Accessible with the following methods

Method Description
GET_ACTIONONFAILURE() Getter for ACTIONONFAILURE, with configurable default
ASK_ACTIONONFAILURE() Getter for ACTIONONFAILURE w/ exceptions if field has no val
HAS_ACTIONONFAILURE() Determine if ACTIONONFAILURE has a value

Status

The current execution status details of the cluster step.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS

ExecutionRoleArn

The Amazon Resource Name (ARN) of the runtime role for a step on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource.

For example, arn:aws:IAM::1234567890:role/ReadOnly is a correctly formatted runtime role ARN.

Accessible with the following methods

Method Description
GET_EXECUTIONROLEARN() Getter for EXECUTIONROLEARN, with configurable default
ASK_EXECUTIONROLEARN() Getter for EXECUTIONROLEARN w/ exceptions if field has no va
HAS_EXECUTIONROLEARN() Determine if EXECUTIONROLEARN has a value

LogUri

The Amazon S3 destination URI for log publishing.

Accessible with the following methods

Method Description
GET_LOGURI() Getter for LOGURI, with configurable default
ASK_LOGURI() Getter for LOGURI w/ exceptions if field has no value
HAS_LOGURI() Determine if LOGURI has a value

EncryptionKeyArn

The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.

Accessible with the following methods

Method Description
GET_ENCRYPTIONKEYARN() Getter for ENCRYPTIONKEYARN, with configurable default
ASK_ENCRYPTIONKEYARN() Getter for ENCRYPTIONKEYARN w/ exceptions if field has no va
HAS_ENCRYPTIONKEYARN() Determine if ENCRYPTIONKEYARN has a value