software.amazon.awscdk.services.emr

Class CfnStep

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.emr.CfnStep

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-02T20:25:25.412Z")
public class CfnStep
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EMR::Step`.

Use Step to specify a cluster (job flow) step, which runs only on the master node. Steps are used to submit data processing jobs to a cluster.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.emr.*;
 CfnStep cfnStep = CfnStep.Builder.create(this, "MyCfnStep")
         .actionOnFailure("actionOnFailure")
         .hadoopJarStep(HadoopJarStepConfigProperty.builder()
                 .jar("jar")
                 // the properties below are optional
                 .args(List.of("args"))
                 .mainClass("mainClass")
                 .stepProperties(List.of(KeyValueProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build())
         .jobFlowId("jobFlowId")
         .name("name")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnStep.Builder A fluent builder for CfnStep.
static interface	CfnStep.HadoopJarStepConfigProperty A job flow step consisting of a JAR file whose main function will be executed.
static interface	CfnStep.KeyValueProperty `KeyValue` is a subproperty of the `HadoopJarStepConfig` property type.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStep(Construct scope, java.lang.String id, CfnStepProps props) Create a new `AWS::EMR::Step`.
protected	CfnStep(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStep(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActionOnFailure() This specifies what action to take when the cluster step fails.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getHadoopJarStep() The `HadoopJarStepConfig` property type specifies a job flow step consisting of a JAR file whose main function will be executed.
java.lang.String	getJobFlowId() A string that uniquely identifies the cluster (job flow).
java.lang.String	getName() The name of the cluster step.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setActionOnFailure(java.lang.String value) This specifies what action to take when the cluster step fails.
void	setHadoopJarStep(CfnStep.HadoopJarStepConfigProperty value) The `HadoopJarStepConfig` property type specifies a job flow step consisting of a JAR file whose main function will be executed.
void	setHadoopJarStep(IResolvable value) The `HadoopJarStepConfig` property type specifies a job flow step consisting of a JAR file whose main function will be executed.
void	setJobFlowId(java.lang.String value) A string that uniquely identifies the cluster (job flow).
void	setName(java.lang.String value) The name of the cluster step.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStep

protected CfnStep(software.amazon.jsii.JsiiObjectRef objRef)

CfnStep

protected CfnStep(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnStep

public CfnStep(Construct scope,
               java.lang.String id,
               CfnStepProps props)

Create a new `AWS::EMR::Step`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getActionOnFailure

public java.lang.String getActionOnFailure()

This specifies what action to take when the cluster step fails.

Possible values are CANCEL_AND_WAIT and CONTINUE .

setActionOnFailure

public void setActionOnFailure(java.lang.String value)

This specifies what action to take when the cluster step fails.

Possible values are CANCEL_AND_WAIT and CONTINUE .

getHadoopJarStep

public java.lang.Object getHadoopJarStep()

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.

setHadoopJarStep

public void setHadoopJarStep(IResolvable value)

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.

setHadoopJarStep

public void setHadoopJarStep(CfnStep.HadoopJarStepConfigProperty value)

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.

getJobFlowId

public java.lang.String getJobFlowId()

A string that uniquely identifies the cluster (job flow).

setJobFlowId

public void setJobFlowId(java.lang.String value)

A string that uniquely identifies the cluster (job flow).

getName

public java.lang.String getName()

The name of the cluster step.

setName

public void setName(java.lang.String value)

The name of the cluster step.