Skip to content
v2.275.0

CfnStepProps Struct ​

Properties for defining a CfnStep.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_emr as emr } from 'aws-cdk-lib';
const cfnStepProps: emr.CfnStepProps = {
  actionOnFailure: 'actionOnFailure',
  hadoopJarStep: {
    jar: 'jar',

    // the properties below are optional
    args: ['args'],
    mainClass: 'mainClass',
    stepProperties: [{
      key: 'key',
      value: 'value',
    }],
  },
  jobFlowId: 'jobFlowId',
  name: 'name',

  // the properties below are optional
  encryptionKeyArn: 'encryptionKeyArn',
  logUri: 'logUri',
};

Properties ​

actionOnFailurestringaction_on_failurestractionOnFailureStringActionOnFailurestringActionOnFailure*stringrequired#
This specifies what action to take when the cluster step fails.

Possible values are CANCEL_AND_WAIT and CONTINUE .

encryptionKeyArnoptionalstringencryption_key_arnoptionalstrencryptionKeyArnoptionalStringEncryptionKeyArnoptionalstringEncryptionKeyArnoptional*string#
The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.

When omitted, EMR falls back to cluster-level logging behavior.

hadoopJarStepIResolvable | CfnStep.HadoopJarStepConfigPropertyhadoop_jar_steptyping.Union[IResolvable, HadoopJarStepConfigProperty]hadoopJarStepIResolvableHadoopJarStepIResolvableHadoopJarStepinterface{}required#
The `HadoopJarStepConfig` property type specifies a job flow step consisting of a JAR file whose main function will be executed.

The main function submits a job for the cluster to execute as a step on the master node, and then waits for the job to finish or fail before executing subsequent steps.

jobFlowIdstringjob_flow_idstrjobFlowIdStringJobFlowIdstringJobFlowId*stringrequired#
A string that uniquely identifies the cluster (job flow).
logUrioptionalstringlog_urioptionalstrlogUrioptionalStringLogUrioptionalstringLogUrioptional*string#
The Amazon S3 destination URI for log publishing.

When omitted, EMR falls back to cluster-level logging behavior.

namestringnamestrnameStringNamestringName*stringrequired#
The name of the cluster step.