Class CfnStep
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.emr.CfnStep
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-27T16:50:57.795Z")
@Stability(Stable)
public class CfnStep
extends CfnResource
implements IInspectable
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
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnStep
.static interface
A job flow step consisting of a JAR file whose main function will be executed.static interface
KeyValue
is a subproperty of theHadoopJarStepConfig
property type.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnStep
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnStep
(software.amazon.jsii.JsiiObjectRef objRef) CfnStep
(software.constructs.Construct scope, String id, CfnStepProps props) -
Method Summary
Modifier and TypeMethodDescriptionThis specifies what action to take when the cluster step fails.The identifier of the cluster step.TheHadoopJarStepConfig
property type specifies a job flow step consisting of a JAR file whose main function will be executed.A string that uniquely identifies the cluster (job flow).getName()
The name of the cluster step.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setActionOnFailure
(String value) This specifies what action to take when the cluster step fails.void
setHadoopJarStep
(IResolvable value) TheHadoopJarStepConfig
property type specifies a job flow step consisting of a JAR file whose main function will be executed.void
TheHadoopJarStepConfig
property type specifies a job flow step consisting of a JAR file whose main function will be executed.void
setJobFlowId
(String value) A string that uniquely identifies the cluster (job flow).void
The name of the cluster step.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnStep
protected CfnStep(software.amazon.jsii.JsiiObjectRef objRef) -
CfnStep
protected CfnStep(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnStep
@Stability(Stable) public CfnStep(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnStepProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
The identifier of the cluster step. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getActionOnFailure
This specifies what action to take when the cluster step fails. -
setActionOnFailure
This specifies what action to take when the cluster step fails. -
getHadoopJarStep
TheHadoopJarStepConfig
property type specifies a job flow step consisting of a JAR file whose main function will be executed. -
setHadoopJarStep
TheHadoopJarStepConfig
property type specifies a job flow step consisting of a JAR file whose main function will be executed. -
setHadoopJarStep
TheHadoopJarStepConfig
property type specifies a job flow step consisting of a JAR file whose main function will be executed. -
getJobFlowId
A string that uniquely identifies the cluster (job flow). -
setJobFlowId
A string that uniquely identifies the cluster (job flow). -
getName
The name of the cluster step. -
setName
The name of the cluster step.
-