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

Class EmrCreateCluster.Builder

java.lang.Object
software.amazon.awscdk.services.stepfunctions.tasks.EmrCreateCluster.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<EmrCreateCluster>
Enclosing class:
EmrCreateCluster
@Stability(Stable) public static final class EmrCreateCluster.Builder extends Object implements software.amazon.jsii.Builder<EmrCreateCluster>
A fluent builder for EmrCreateCluster.

  • Method Details

    • create

      @Stability(Stable) public static EmrCreateCluster.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - Descriptive identifier for this chainable. This parameter is required.
      Returns:
      a new instance of EmrCreateCluster.Builder.

    • comment

      @Stability(Stable) public EmrCreateCluster.Builder comment(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

    • credentials

      @Stability(Stable) public EmrCreateCluster.Builder credentials(Credentials credentials)
      Credentials for an IAM Role that the State Machine assumes for executing the task.

      This enables cross-account resource invocations.

      Default: - None (Task is executed using the State Machine's execution role)

      Parameters:
      credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This parameter is required.
      Returns:
      this
      See Also:

    • heartbeat

      @Stability(Deprecated) @Deprecated public EmrCreateCluster.Builder heartbeat(Duration heartbeat)
      Deprecated.
      use heartbeatTimeout
      (deprecated) Timeout for the heartbeat.

      Default: - None

      Parameters:
      heartbeat - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • heartbeatTimeout

      @Stability(Stable) public EmrCreateCluster.Builder heartbeatTimeout(Timeout heartbeatTimeout)
      Timeout for the heartbeat.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      heartbeatTimeout - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • inputPath

      @Stability(Stable) public EmrCreateCluster.Builder inputPath(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

      @Stability(Stable) 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.

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

      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:

    • outputPath

      @Stability(Stable) public EmrCreateCluster.Builder outputPath(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

      @Stability(Stable) public EmrCreateCluster.Builder resultPath(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

      @Stability(Stable) public EmrCreateCluster.Builder resultSelector(Map<String,? extends 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:

    • stateName

      @Stability(Stable) public EmrCreateCluster.Builder stateName(String stateName)
      Optional name for this state.

      Default: - The construct ID will be used as state name

      Parameters:
      stateName - Optional name for this state. This parameter is required.
      Returns:
      this

    • taskTimeout

      @Stability(Stable) public EmrCreateCluster.Builder taskTimeout(Timeout taskTimeout)
      Timeout for the task.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      taskTimeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • timeout

      @Stability(Deprecated) @Deprecated public EmrCreateCluster.Builder timeout(Duration timeout)
      Deprecated.
      use taskTimeout
      (deprecated) Timeout for the task.

      Default: - None

      Parameters:
      timeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • instances

      @Stability(Stable) 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

      @Stability(Stable) public EmrCreateCluster.Builder name(String name)
      The Name of the Cluster.

      Parameters:
      name - The Name of the Cluster. This parameter is required.
      Returns:
      this

    • additionalInfo

      @Stability(Stable) public EmrCreateCluster.Builder additionalInfo(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

      @Stability(Stable) public EmrCreateCluster.Builder applications(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

      @Stability(Stable) 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

    • autoTerminationPolicyIdleTimeout

      @Stability(Stable) public EmrCreateCluster.Builder autoTerminationPolicyIdleTimeout(Duration 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).

      Default: - No timeout

      Parameters:
      autoTerminationPolicyIdleTimeout - The amount of idle time after which the cluster automatically terminates. This parameter is required.
      Returns:
      this

    • bootstrapActions

      @Stability(Stable) public EmrCreateCluster.Builder bootstrapActions(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

      @Stability(Stable) 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

      @Stability(Stable) public EmrCreateCluster.Builder configurations(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

      @Stability(Stable) public EmrCreateCluster.Builder customAmiId(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

      @Stability(Stable) 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

      @Stability(Stable) 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

      @Stability(Stable) public EmrCreateCluster.Builder logUri(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

      @Stability(Stable) public EmrCreateCluster.Builder releaseLabel(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

      @Stability(Stable) 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

      @Stability(Stable) public EmrCreateCluster.Builder securityConfiguration(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

      @Stability(Stable) 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

      @Stability(Stable) public EmrCreateCluster.Builder stepConcurrencyLevel(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

      @Stability(Stable) public EmrCreateCluster.Builder tags(Map<String,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

      @Stability(Stable) public EmrCreateCluster.Builder visibleToAllUsers(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

      @Stability(Stable) public EmrCreateCluster build()
      Specified by:
      build in interface software.amazon.jsii.Builder<EmrCreateCluster>
      Returns:
      a newly built instance of EmrCreateCluster.