Show / Hide Table of Contents

Class CfnStep

A CloudFormation AWS::EMR::Step.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnStep
Implements
IConstruct
Constructs.IConstruct
IDependable
IInspectable
Inherited Members
CfnResource.IsCfnResource(IConstruct)
CfnResource.AddDeletionOverride(String)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(String, Object)
CfnResource.AddOverride(String, Object)
CfnResource.AddPropertyDeletionOverride(String)
CfnResource.AddPropertyOverride(String, Object)
CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)
CfnResource.GetAtt(String)
CfnResource.GetMetadata(String)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(Object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.UpdatedProperites
CfnRefElement.Ref
CfnElement.IsCfnElement(Object)
CfnElement.OverrideLogicalId(String)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK.AWS.EMR
Assembly: Amazon.CDK.AWS.EMR.dll
Syntax (csharp)
public class CfnStep : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnStep
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks

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.

CloudformationResource: AWS::EMR::Step

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EMR;

CfnStep cfnStep = new CfnStep(this, "MyCfnStep", new CfnStepProps {
    ActionOnFailure = "actionOnFailure",
    HadoopJarStep = new HadoopJarStepConfigProperty {
        Jar = "jar",

        // the properties below are optional
        Args = new [] { "args" },
        MainClass = "mainClass",
        StepProperties = new [] { new KeyValueProperty {
            Key = "key",
            Value = "value"
        } }
    },
    JobFlowId = "jobFlowId",
    Name = "name"
});

Synopsis

Constructors

CfnStep(Construct, String, ICfnStepProps)

Create a new AWS::EMR::Step.

CfnStep(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

CfnStep(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

ActionOnFailure

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

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties
HadoopJarStep

The HadoopJarStepConfig property type specifies a job flow step consisting of a JAR file whose main function will be executed.

JobFlowId

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

Name

The name of the cluster step.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<String, Object>)

Constructors

CfnStep(Construct, String, ICfnStepProps)

Create a new AWS::EMR::Step.

public CfnStep(Construct scope, string id, ICfnStepProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnStepProps
  • resource properties.

CfnStep(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnStep(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnStep(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnStep(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

ActionOnFailure

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

public virtual string ActionOnFailure { get; set; }
Property Value

System.String

Remarks

Possible values are CANCEL_AND_WAIT and CONTINUE .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-elasticmapreduce-step-actiononfailure

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides
CfnResource.CfnProperties

HadoopJarStep

The HadoopJarStepConfig property type specifies a job flow step consisting of a JAR file whose main function will be executed.

public virtual object HadoopJarStep { get; set; }
Property Value

System.Object

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-elasticmapreduce-step-hadoopjarstep

JobFlowId

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

public virtual string JobFlowId { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-elasticmapreduce-step-jobflowid

Name

The name of the cluster step.

public virtual string Name { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-step.html#cfn-elasticmapreduce-step-name

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector
  • tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides
CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct
Constructs.IConstruct
IDependable
IInspectable
Back to top Generated by DocFX