Package software.amazon.awscdk.services.stepfunctions.tasks

Class EmrCreateClusterProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.EmrCreateClusterProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EmrCreateClusterProps>

Enclosing interface:

EmrCreateClusterProps

@Stability(Stable)
public static final class EmrCreateClusterProps.Builder
extends Object
implements software.amazon.jsii.Builder<EmrCreateClusterProps>

A builder for EmrCreateClusterProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EmrCreateClusterProps.Builder	additionalInfo(String additionalInfo)	Sets the value of EmrCreateClusterProps.getAdditionalInfo()
EmrCreateClusterProps.Builder	applications(List<? extends EmrCreateCluster.ApplicationConfigProperty> applications)	Sets the value of EmrCreateClusterProps.getApplications()
EmrCreateClusterProps.Builder	autoScalingRole(IRole autoScalingRole)	Sets the value of EmrCreateClusterProps.getAutoScalingRole()
EmrCreateClusterProps.Builder	autoTerminationPolicyIdleTimeout(Duration autoTerminationPolicyIdleTimeout)	Sets the value of EmrCreateClusterProps.getAutoTerminationPolicyIdleTimeout()
EmrCreateClusterProps.Builder	bootstrapActions(List<? extends EmrCreateCluster.BootstrapActionConfigProperty> bootstrapActions)	Sets the value of EmrCreateClusterProps.getBootstrapActions()
EmrCreateClusterProps	build()	Builds the configured instance.
EmrCreateClusterProps.Builder	clusterRole(IRole clusterRole)	Sets the value of EmrCreateClusterProps.getClusterRole()
EmrCreateClusterProps.Builder	comment(String comment)	Sets the value of TaskStateBaseProps.getComment()
EmrCreateClusterProps.Builder	configurations(List<? extends EmrCreateCluster.ConfigurationProperty> configurations)	Sets the value of EmrCreateClusterProps.getConfigurations()
EmrCreateClusterProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseProps.getCredentials()
EmrCreateClusterProps.Builder	customAmiId(String customAmiId)	Sets the value of EmrCreateClusterProps.getCustomAmiId()
EmrCreateClusterProps.Builder	ebsRootVolumeSize(Size ebsRootVolumeSize)	Sets the value of EmrCreateClusterProps.getEbsRootVolumeSize()
EmrCreateClusterProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
EmrCreateClusterProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseProps.getHeartbeatTimeout()
EmrCreateClusterProps.Builder	inputPath(String inputPath)	Sets the value of TaskStateBaseProps.getInputPath()
EmrCreateClusterProps.Builder	instances(EmrCreateCluster.InstancesConfigProperty instances)	Sets the value of EmrCreateClusterProps.getInstances()
EmrCreateClusterProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseProps.getIntegrationPattern()
EmrCreateClusterProps.Builder	kerberosAttributes(EmrCreateCluster.KerberosAttributesProperty kerberosAttributes)	Sets the value of EmrCreateClusterProps.getKerberosAttributes()
EmrCreateClusterProps.Builder	logUri(String logUri)	Sets the value of EmrCreateClusterProps.getLogUri()
EmrCreateClusterProps.Builder	name(String name)	Sets the value of EmrCreateClusterProps.getName()
EmrCreateClusterProps.Builder	outputPath(String outputPath)	Sets the value of TaskStateBaseProps.getOutputPath()
EmrCreateClusterProps.Builder	releaseLabel(String releaseLabel)	Sets the value of EmrCreateClusterProps.getReleaseLabel()
EmrCreateClusterProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateBaseProps.getResultPath()
EmrCreateClusterProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateBaseProps.getResultSelector()
EmrCreateClusterProps.Builder	scaleDownBehavior(EmrCreateCluster.EmrClusterScaleDownBehavior scaleDownBehavior)	Sets the value of EmrCreateClusterProps.getScaleDownBehavior()
EmrCreateClusterProps.Builder	securityConfiguration(String securityConfiguration)	Sets the value of EmrCreateClusterProps.getSecurityConfiguration()
EmrCreateClusterProps.Builder	serviceRole(IRole serviceRole)	Sets the value of EmrCreateClusterProps.getServiceRole()
EmrCreateClusterProps.Builder	stateName(String stateName)	Sets the value of TaskStateBaseProps.getStateName()
EmrCreateClusterProps.Builder	stepConcurrencyLevel(Number stepConcurrencyLevel)	Sets the value of EmrCreateClusterProps.getStepConcurrencyLevel()
EmrCreateClusterProps.Builder	tags(Map<String,String> tags)	Sets the value of EmrCreateClusterProps.getTags()
EmrCreateClusterProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseProps.getTaskTimeout()
EmrCreateClusterProps.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`
EmrCreateClusterProps.Builder	visibleToAllUsers(Boolean visibleToAllUsers)	Sets the value of EmrCreateClusterProps.getVisibleToAllUsers()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

instances

@Stability(Stable)
public EmrCreateClusterProps.Builder instances(EmrCreateCluster.InstancesConfigProperty instances)

Sets the value of EmrCreateClusterProps.getInstances()

Parameters:

instances - A specification of the number and type of Amazon EC2 instances. This parameter is required.

Returns:

this

name

@Stability(Stable)
public EmrCreateClusterProps.Builder name(String name)

Sets the value of EmrCreateClusterProps.getName()

Parameters:

name - The Name of the Cluster. This parameter is required.

Returns:

this

additionalInfo

@Stability(Stable)
public EmrCreateClusterProps.Builder additionalInfo(String additionalInfo)

Sets the value of EmrCreateClusterProps.getAdditionalInfo()

Parameters:

additionalInfo - A JSON string for selecting additional features.

Returns:

this

applications

@Stability(Stable)
public EmrCreateClusterProps.Builder applications(List<? extends EmrCreateCluster.ApplicationConfigProperty> applications)

Sets the value of EmrCreateClusterProps.getApplications()

Parameters:

applications - A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster.

Returns:

this

autoScalingRole

@Stability(Stable)
public EmrCreateClusterProps.Builder autoScalingRole(IRole autoScalingRole)

Sets the value of EmrCreateClusterProps.getAutoScalingRole()

Parameters:

autoScalingRole - An IAM role for automatic scaling policies.

Returns:

this

autoTerminationPolicyIdleTimeout

@Stability(Stable)
public EmrCreateClusterProps.Builder autoTerminationPolicyIdleTimeout(Duration autoTerminationPolicyIdleTimeout)

Sets the value of EmrCreateClusterProps.getAutoTerminationPolicyIdleTimeout()

Parameters:

autoTerminationPolicyIdleTimeout - The amount of idle time after which the cluster automatically terminates. You can specify a minimum of 60 seconds and a maximum of 604800 seconds (seven days).

Returns:

this

bootstrapActions

@Stability(Stable)
public EmrCreateClusterProps.Builder bootstrapActions(List<? extends EmrCreateCluster.BootstrapActionConfigProperty> bootstrapActions)

Sets the value of EmrCreateClusterProps.getBootstrapActions()

Parameters:

bootstrapActions - A list of bootstrap actions to run before Hadoop starts on the cluster nodes.

Returns:

this

clusterRole

@Stability(Stable)
public EmrCreateClusterProps.Builder clusterRole(IRole clusterRole)

Sets the value of EmrCreateClusterProps.getClusterRole()

Parameters:

clusterRole - Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role.

This attribute has been renamed from jobFlowRole to clusterRole to align with other ERM/StepFunction integration parameters.

Returns:

this

configurations

@Stability(Stable)
public EmrCreateClusterProps.Builder configurations(List<? extends EmrCreateCluster.ConfigurationProperty> configurations)

Sets the value of EmrCreateClusterProps.getConfigurations()

Parameters:

configurations - The list of configurations supplied for the EMR cluster you are creating.

Returns:

this

customAmiId

@Stability(Stable)
public EmrCreateClusterProps.Builder customAmiId(String customAmiId)

Sets the value of EmrCreateClusterProps.getCustomAmiId()

Parameters:

customAmiId - The ID of a custom Amazon EBS-backed Linux AMI.

Returns:

this

ebsRootVolumeSize

@Stability(Stable)
public EmrCreateClusterProps.Builder ebsRootVolumeSize(Size ebsRootVolumeSize)

Sets the value of EmrCreateClusterProps.getEbsRootVolumeSize()

Parameters:

ebsRootVolumeSize - The size of the EBS root device volume of the Linux AMI that is used for each EC2 instance.

Returns:

this

kerberosAttributes

@Stability(Stable)
public EmrCreateClusterProps.Builder kerberosAttributes(EmrCreateCluster.KerberosAttributesProperty kerberosAttributes)

Sets the value of EmrCreateClusterProps.getKerberosAttributes()

Parameters:

kerberosAttributes - Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.

Returns:

this

logUri

@Stability(Stable)
public EmrCreateClusterProps.Builder logUri(String logUri)

Sets the value of EmrCreateClusterProps.getLogUri()

Parameters:

logUri - The location in Amazon S3 to write the log files of the job flow.

Returns:

this

releaseLabel

@Stability(Stable)
public EmrCreateClusterProps.Builder releaseLabel(String releaseLabel)

Sets the value of EmrCreateClusterProps.getReleaseLabel()

Parameters:

releaseLabel - The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.

Returns:

this

scaleDownBehavior

@Stability(Stable)
public EmrCreateClusterProps.Builder scaleDownBehavior(EmrCreateCluster.EmrClusterScaleDownBehavior scaleDownBehavior)

Sets the value of EmrCreateClusterProps.getScaleDownBehavior()

Parameters:

scaleDownBehavior - Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.

Returns:

this

securityConfiguration

@Stability(Stable)
public EmrCreateClusterProps.Builder securityConfiguration(String securityConfiguration)

Sets the value of EmrCreateClusterProps.getSecurityConfiguration()

Parameters:

securityConfiguration - The name of a security configuration to apply to the cluster.

Returns:

this

serviceRole

@Stability(Stable)
public EmrCreateClusterProps.Builder serviceRole(IRole serviceRole)

Sets the value of EmrCreateClusterProps.getServiceRole()

Parameters:

serviceRole - The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

Returns:

this

stepConcurrencyLevel

@Stability(Stable)
public EmrCreateClusterProps.Builder stepConcurrencyLevel(Number stepConcurrencyLevel)

Sets the value of EmrCreateClusterProps.getStepConcurrencyLevel()

Parameters:

stepConcurrencyLevel - Specifies the step concurrency level to allow multiple steps to run in parallel. Requires EMR release label 5.28.0 or above. Must be in range [1, 256].

Returns:

this

tags

@Stability(Stable)
public EmrCreateClusterProps.Builder tags(Map<String,String> tags)

Sets the value of EmrCreateClusterProps.getTags()

Parameters:

tags - A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

Returns:

this

visibleToAllUsers

@Stability(Stable)
public EmrCreateClusterProps.Builder visibleToAllUsers(Boolean visibleToAllUsers)

Sets the value of EmrCreateClusterProps.getVisibleToAllUsers()

Parameters:

visibleToAllUsers - A value of true indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions.

Returns:

this

comment

@Stability(Stable)
public EmrCreateClusterProps.Builder comment(String comment)

Sets the value of TaskStateBaseProps.getComment()

Parameters:

comment - An optional description for this state.

Returns:

this

credentials

@Stability(Stable)
public EmrCreateClusterProps.Builder credentials(Credentials credentials)

Sets the value of TaskStateBaseProps.getCredentials()

Parameters:

credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.

Returns:

this

heartbeat

@Stability(Deprecated)
@Deprecated
public EmrCreateClusterProps.Builder heartbeat(Duration heartbeat)

Deprecated.

use `heartbeatTimeout`

Sets the value of TaskStateBaseProps.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

heartbeatTimeout

@Stability(Stable)
public EmrCreateClusterProps.Builder heartbeatTimeout(Timeout heartbeatTimeout)

Sets the value of TaskStateBaseProps.getHeartbeatTimeout()

Parameters:

heartbeatTimeout - Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

inputPath

@Stability(Stable)
public EmrCreateClusterProps.Builder inputPath(String inputPath)

Sets the value of TaskStateBaseProps.getInputPath()

Parameters:

inputPath - JSONPath expression to select part of the state to be the input to this state. May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Returns:

this

integrationPattern

@Stability(Stable)
public EmrCreateClusterProps.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseProps.getIntegrationPattern()

Parameters:

integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Returns:

this

outputPath

@Stability(Stable)
public EmrCreateClusterProps.Builder outputPath(String outputPath)

Sets the value of TaskStateBaseProps.getOutputPath()

Parameters:

outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Returns:

this

resultPath

@Stability(Stable)
public EmrCreateClusterProps.Builder resultPath(String resultPath)

Sets the value of TaskStateBaseProps.getResultPath()

Parameters:

resultPath - JSONPath expression to indicate where to inject the state's output. May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Returns:

this

resultSelector

@Stability(Stable)
public EmrCreateClusterProps.Builder resultSelector(Map<String,? extends Object> resultSelector)

Sets the value of TaskStateBaseProps.getResultSelector()

Parameters:

resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Returns:

this

stateName

@Stability(Stable)
public EmrCreateClusterProps.Builder stateName(String stateName)

Sets the value of TaskStateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

taskTimeout

@Stability(Stable)
public EmrCreateClusterProps.Builder taskTimeout(Timeout taskTimeout)

Sets the value of TaskStateBaseProps.getTaskTimeout()

Parameters:

taskTimeout - Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

timeout

@Stability(Deprecated)
@Deprecated
public EmrCreateClusterProps.Builder timeout(Duration timeout)

Deprecated.

use `taskTimeout`

Sets the value of TaskStateBaseProps.getTimeout()

Parameters:

timeout - Timeout for the task.

Returns:

this

build

@Stability(Stable)
public EmrCreateClusterProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<EmrCreateClusterProps>

Returns:

a new instance of EmrCreateClusterProps

Throws:

NullPointerException - if any required attribute was not provided