EmrCreateCluster.Builder

java.lang.Object
- software.amazon.awscdk.services.stepfunctions.tasks.EmrCreateCluster.Builder

Enclosing class:: EmrCreateCluster

public static final class EmrCreateCluster.Builder
extends java.lang.Object

A fluent builder for EmrCreateCluster.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EmrCreateCluster.Builder`	`additionalInfo(java.lang.String additionalInfo)` A JSON string for selecting additional features.
`EmrCreateCluster.Builder`	`applications(java.util.List<? extends EmrCreateCluster.ApplicationConfigProperty> applications)` A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster.
`EmrCreateCluster.Builder`	`autoScalingRole(IRole autoScalingRole)` An IAM role for automatic scaling policies.
`EmrCreateCluster.Builder`	`bootstrapActions(java.util.List<? extends EmrCreateCluster.BootstrapActionConfigProperty> bootstrapActions)` A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
`EmrCreateCluster`	`build()`
`EmrCreateCluster.Builder`	`clusterRole(IRole clusterRole)` Also called instance profile and EC2 role.
`EmrCreateCluster.Builder`	`comment(java.lang.String comment)` An optional description for this state.
`EmrCreateCluster.Builder`	`configurations(java.util.List<? extends EmrCreateCluster.ConfigurationProperty> configurations)` The list of configurations supplied for the EMR cluster you are creating.
`static EmrCreateCluster.Builder`	`create(software.constructs.Construct scope, java.lang.String id)`
`EmrCreateCluster.Builder`	`customAmiId(java.lang.String customAmiId)` The ID of a custom Amazon EBS-backed Linux AMI.
`EmrCreateCluster.Builder`	`ebsRootVolumeSize(Size ebsRootVolumeSize)` The size of the EBS root device volume of the Linux AMI that is used for each EC2 instance.
`EmrCreateCluster.Builder`	`heartbeat(Duration heartbeat)` Timeout for the heartbeat.
`EmrCreateCluster.Builder`	`inputPath(java.lang.String inputPath)` JSONPath expression to select part of the state to be the input to this state.
`EmrCreateCluster.Builder`	`instances(EmrCreateCluster.InstancesConfigProperty instances)` A specification of the number and type of Amazon EC2 instances.
`EmrCreateCluster.Builder`	`integrationPattern(IntegrationPattern integrationPattern)` AWS Step Functions integrates with services directly in the Amazon States Language.
`EmrCreateCluster.Builder`	`kerberosAttributes(EmrCreateCluster.KerberosAttributesProperty kerberosAttributes)` Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.
`EmrCreateCluster.Builder`	`logUri(java.lang.String logUri)` The location in Amazon S3 to write the log files of the job flow.
`EmrCreateCluster.Builder`	`name(java.lang.String name)` The Name of the Cluster.
`EmrCreateCluster.Builder`	`outputPath(java.lang.String outputPath)` JSONPath expression to select select a portion of the state output to pass to the next state.
`EmrCreateCluster.Builder`	`releaseLabel(java.lang.String releaseLabel)` The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.
`EmrCreateCluster.Builder`	`resultPath(java.lang.String resultPath)` JSONPath expression to indicate where to inject the state's output.
`EmrCreateCluster.Builder`	`resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector)` The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
`EmrCreateCluster.Builder`	`scaleDownBehavior(EmrCreateCluster.EmrClusterScaleDownBehavior scaleDownBehavior)` Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
`EmrCreateCluster.Builder`	`securityConfiguration(java.lang.String securityConfiguration)` The name of a security configuration to apply to the cluster.
`EmrCreateCluster.Builder`	`serviceRole(IRole serviceRole)` The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
`EmrCreateCluster.Builder`	`stepConcurrencyLevel(java.lang.Number stepConcurrencyLevel)` Specifies the step concurrency level to allow multiple steps to run in parallel.
`EmrCreateCluster.Builder`	`tags(java.util.Map<java.lang.String,java.lang.String> tags)` A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
`EmrCreateCluster.Builder`	`timeout(Duration timeout)` Timeout for the state machine.
`EmrCreateCluster.Builder`	`visibleToAllUsers(java.lang.Boolean 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static EmrCreateCluster.Builder create(software.constructs.Construct scope,
                                              java.lang.String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of EmrCreateCluster.ApplicationConfigProperty.Builder.
  - comment
```
public EmrCreateCluster.Builder comment(java.lang.String comment)
```
    An optional description for this state.
    Default: - No comment
    
    Parameters:
    
    comment - An optional description for this state. This parameter is required.
    
    Returns:
    
    this
  - heartbeat
```
public EmrCreateCluster.Builder heartbeat(Duration heartbeat)
```
    Timeout for the heartbeat.
    Default: - None
    
    Parameters:
    
    heartbeat - Timeout for the heartbeat. This parameter is required.
    
    Returns:
    
    this
  - inputPath
```
public EmrCreateCluster.Builder inputPath(java.lang.String 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 {}.
    Default: - The entire task input (JSON path '$')
    
    Parameters:
    
    inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.
    
    Returns:
    
    this
  - integrationPattern
```
public EmrCreateCluster.Builder integrationPattern(IntegrationPattern integrationPattern)
```
    AWS Step Functions integrates with services directly in the Amazon States Language.
    You can control these AWS services using service integration patterns
    Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.
    
    Parameters:
    
    integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
  - outputPath
```
public EmrCreateCluster.Builder outputPath(java.lang.String 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 {}.
    Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
    
    Parameters:
    
    outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.
    
    Returns:
    
    this
  - resultPath
```
public EmrCreateCluster.Builder resultPath(java.lang.String 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.
    Default: - Replaces the entire input with the result (JSON path '$')
    
    Parameters:
    
    resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.
    
    Returns:
    
    this
  - resultSelector
```
public EmrCreateCluster.Builder resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> 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.
    Default: - None
    
    Parameters:
    
    resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector
  - timeout
```
public EmrCreateCluster.Builder timeout(Duration timeout)
```
    Timeout for the state machine.
    Default: - None
    
    Parameters:
    
    timeout - Timeout for the state machine. This parameter is required.
    
    Returns:
    
    this
  - instances
```
public EmrCreateCluster.Builder instances(EmrCreateCluster.InstancesConfigProperty instances)
```
    A specification of the number and type of Amazon EC2 instances.
    
    Parameters:
    
    instances - A specification of the number and type of Amazon EC2 instances. This parameter is required.
    
    Returns:
    
    this
  - name
```
public EmrCreateCluster.Builder name(java.lang.String name)
```
    The Name of the Cluster.
    
    Parameters:
    
    name - The Name of the Cluster. This parameter is required.
    
    Returns:
    
    this
  - additionalInfo
```
public EmrCreateCluster.Builder additionalInfo(java.lang.String additionalInfo)
```
    A JSON string for selecting additional features.
    Default: - None
    
    Parameters:
    
    additionalInfo - A JSON string for selecting additional features. This parameter is required.
    
    Returns:
    
    this
  - applications
```
public EmrCreateCluster.Builder applications(java.util.List<? extends EmrCreateCluster.ApplicationConfigProperty> applications)
```
    A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster.
    Default: - EMR selected default
    
    Parameters:
    
    applications - A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. This parameter is required.
    
    Returns:
    
    this
  - autoScalingRole
```
public EmrCreateCluster.Builder autoScalingRole(IRole autoScalingRole)
```
    An IAM role for automatic scaling policies.
    Default: - A role will be created.
    
    Parameters:
    
    autoScalingRole - An IAM role for automatic scaling policies. This parameter is required.
    
    Returns:
    
    this
  - bootstrapActions
```
public EmrCreateCluster.Builder bootstrapActions(java.util.List<? extends EmrCreateCluster.BootstrapActionConfigProperty> bootstrapActions)
```
    A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
    Default: - None
    
    Parameters:
    
    bootstrapActions - A list of bootstrap actions to run before Hadoop starts on the cluster nodes. This parameter is required.
    
    Returns:
    
    this
  - clusterRole
```
public EmrCreateCluster.Builder clusterRole(IRole 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.
    Default: - * A Role will be created
    
    Parameters:
    
    clusterRole - Also called instance profile and EC2 role. This parameter is required.
    
    Returns:
    
    this
  - configurations
```
public EmrCreateCluster.Builder configurations(java.util.List<? extends EmrCreateCluster.ConfigurationProperty> configurations)
```
    The list of configurations supplied for the EMR cluster you are creating.
    Default: - None
    
    Parameters:
    
    configurations - The list of configurations supplied for the EMR cluster you are creating. This parameter is required.
    
    Returns:
    
    this
  - customAmiId
```
public EmrCreateCluster.Builder customAmiId(java.lang.String customAmiId)
```
    The ID of a custom Amazon EBS-backed Linux AMI.
    Default: - None
    
    Parameters:
    
    customAmiId - The ID of a custom Amazon EBS-backed Linux AMI. This parameter is required.
    
    Returns:
    
    this
  - ebsRootVolumeSize
```
public EmrCreateCluster.Builder ebsRootVolumeSize(Size ebsRootVolumeSize)
```
    The size of the EBS root device volume of the Linux AMI that is used for each EC2 instance.
    Default: - EMR selected default
    
    Parameters:
    
    ebsRootVolumeSize - The size of the EBS root device volume of the Linux AMI that is used for each EC2 instance. This parameter is required.
    
    Returns:
    
    this
  - kerberosAttributes
```
public EmrCreateCluster.Builder kerberosAttributes(EmrCreateCluster.KerberosAttributesProperty kerberosAttributes)
```
    Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.
    Default: - None
    
    Parameters:
    
    kerberosAttributes - Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. This parameter is required.
    
    Returns:
    
    this
  - logUri
```
public EmrCreateCluster.Builder logUri(java.lang.String logUri)
```
    The location in Amazon S3 to write the log files of the job flow.
    Default: - None
    
    Parameters:
    
    logUri - The location in Amazon S3 to write the log files of the job flow. This parameter is required.
    
    Returns:
    
    this
  - releaseLabel
```
public EmrCreateCluster.Builder releaseLabel(java.lang.String releaseLabel)
```
    The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.
    Default: - EMR selected default
    
    Parameters:
    
    releaseLabel - The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. This parameter is required.
    
    Returns:
    
    this
  - scaleDownBehavior
```
public EmrCreateCluster.Builder scaleDownBehavior(EmrCreateCluster.EmrClusterScaleDownBehavior scaleDownBehavior)
```
    Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
    Default: - EMR selected default
    
    Parameters:
    
    scaleDownBehavior - Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. This parameter is required.
    
    Returns:
    
    this
  - securityConfiguration
```
public EmrCreateCluster.Builder securityConfiguration(java.lang.String securityConfiguration)
```
    The name of a security configuration to apply to the cluster.
    Default: - None
    
    Parameters:
    
    securityConfiguration - The name of a security configuration to apply to the cluster. This parameter is required.
    
    Returns:
    
    this
  - serviceRole
```
public EmrCreateCluster.Builder serviceRole(IRole serviceRole)
```
    The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
    Default: - A role will be created that Amazon EMR service can assume.
    
    Parameters:
    
    serviceRole - The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf. This parameter is required.
    
    Returns:
    
    this
  - stepConcurrencyLevel
```
public EmrCreateCluster.Builder stepConcurrencyLevel(java.lang.Number 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].
    Default: 1 - no step concurrency allowed
    
    Parameters:
    
    stepConcurrencyLevel - Specifies the step concurrency level to allow multiple steps to run in parallel. This parameter is required.
    
    Returns:
    
    this
  - tags
```
public EmrCreateCluster.Builder tags(java.util.Map<java.lang.String,java.lang.String> tags)
```
    A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
    Default: - None
    
    Parameters:
    
    tags - A list of tags to associate with a cluster and propagate to Amazon EC2 instances. This parameter is required.
    
    Returns:
    
    this
  - visibleToAllUsers
```
public EmrCreateCluster.Builder visibleToAllUsers(java.lang.Boolean 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.
    Default: true
    
    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. This parameter is required.
    
    Returns:
    
    this
  - build
```
public EmrCreateCluster build()
```

Class EmrCreateCluster.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

comment

heartbeat

inputPath

integrationPattern

outputPath

resultPath

resultSelector

timeout

instances

name

additionalInfo

applications

autoScalingRole

bootstrapActions

clusterRole

configurations

customAmiId

ebsRootVolumeSize

kerberosAttributes

logUri

releaseLabel

scaleDownBehavior

securityConfiguration

serviceRole

stepConcurrencyLevel

tags

visibleToAllUsers

build