EmrCreateClusterProps

All Superinterfaces:: TaskStateBaseProps

All Known Implementing Classes:: EmrCreateClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-27T16:28:06.649Z")
public interface EmrCreateClusterProps
extends TaskStateBaseProps

Properties for EmrCreateCluster.

See the RunJobFlow API for complete documentation on input parameters

Example:

 Role clusterRole = Role.Builder.create(this, "ClusterRole")
         .assumedBy(new ServicePrincipal("ec2.amazonaws.com"))
         .build();
 Role serviceRole = Role.Builder.create(this, "ServiceRole")
         .assumedBy(new ServicePrincipal("elasticmapreduce.amazonaws.com"))
         .build();
 Role autoScalingRole = Role.Builder.create(this, "AutoScalingRole")
         .assumedBy(new ServicePrincipal("elasticmapreduce.amazonaws.com"))
         .build();
 autoScalingRole.assumeRolePolicy.addStatements(
 PolicyStatement.Builder.create()
         .effect(Effect.ALLOW)
         .principals(List.of(
             new ServicePrincipal("application-autoscaling.amazonaws.com")))
         .actions(List.of("sts:AssumeRole"))
         .build());
 EmrCreateCluster.Builder.create(this, "Create Cluster")
         .instances(InstancesConfigProperty.builder().build())
         .clusterRole(clusterRole)
         .name(TaskInput.fromJsonPathAt("$.ClusterName").getValue())
         .serviceRole(serviceRole)
         .autoScalingRole(autoScalingRole)
         .build();

See Also:: https://docs.aws.amazon.com/emr/latest/APIReference/API_RunJobFlow.html

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`EmrCreateClusterProps.Builder` A builder for `EmrCreateClusterProps`
`static class`	`EmrCreateClusterProps.Jsii$Proxy` An implementation for `EmrCreateClusterProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static EmrCreateClusterProps.Builder`	`builder()`
`default java.lang.String`	`getAdditionalInfo()` A JSON string for selecting additional features.
`default java.util.List<EmrCreateCluster.ApplicationConfigProperty>`	`getApplications()` A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster.
`default IRole`	`getAutoScalingRole()` An IAM role for automatic scaling policies.
`default java.util.List<EmrCreateCluster.BootstrapActionConfigProperty>`	`getBootstrapActions()` A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
`default IRole`	`getClusterRole()` Also called instance profile and EC2 role.
`default java.util.List<EmrCreateCluster.ConfigurationProperty>`	`getConfigurations()` The list of configurations supplied for the EMR cluster you are creating.
`default java.lang.String`	`getCustomAmiId()` The ID of a custom Amazon EBS-backed Linux AMI.
`default Size`	`getEbsRootVolumeSize()` The size of the EBS root device volume of the Linux AMI that is used for each EC2 instance.
`EmrCreateCluster.InstancesConfigProperty`	`getInstances()` A specification of the number and type of Amazon EC2 instances.
`default EmrCreateCluster.KerberosAttributesProperty`	`getKerberosAttributes()` Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.
`default java.lang.String`	`getLogUri()` The location in Amazon S3 to write the log files of the job flow.
`java.lang.String`	`getName()` The Name of the Cluster.
`default java.lang.String`	`getReleaseLabel()` The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.
`default EmrCreateCluster.EmrClusterScaleDownBehavior`	`getScaleDownBehavior()` Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
`default java.lang.String`	`getSecurityConfiguration()` The name of a security configuration to apply to the cluster.
`default IRole`	`getServiceRole()` The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
`default java.lang.Number`	`getStepConcurrencyLevel()` Specifies the step concurrency level to allow multiple steps to run in parallel.
`default java.util.Map<java.lang.String,java.lang.String>`	`getTags()` A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
`default java.lang.Boolean`	`getVisibleToAllUsers()` 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 interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps
getComment, getHeartbeat, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getTimeout

- Method Detail
  - getInstances
```
EmrCreateCluster.InstancesConfigProperty getInstances()
```
    A specification of the number and type of Amazon EC2 instances.
  - getName
```
java.lang.String getName()
```
    The Name of the Cluster.
  - getAdditionalInfo
```
default java.lang.String getAdditionalInfo()
```
    A JSON string for selecting additional features.
    Default: - None
  - getApplications
```
default java.util.List<EmrCreateCluster.ApplicationConfigProperty> getApplications()
```
    A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster.
    Default: - EMR selected default
  - getAutoScalingRole
```
default IRole getAutoScalingRole()
```
    An IAM role for automatic scaling policies.
    Default: - A role will be created.
  - getBootstrapActions
```
default java.util.List<EmrCreateCluster.BootstrapActionConfigProperty> getBootstrapActions()
```
    A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
    Default: - None
  - getClusterRole
```
default IRole getClusterRole()
```
    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
  - getConfigurations
```
default java.util.List<EmrCreateCluster.ConfigurationProperty> getConfigurations()
```
    The list of configurations supplied for the EMR cluster you are creating.
    Default: - None
  - getCustomAmiId
```
default java.lang.String getCustomAmiId()
```
    The ID of a custom Amazon EBS-backed Linux AMI.
    Default: - None
  - getEbsRootVolumeSize
```
default Size getEbsRootVolumeSize()
```
    The size of the EBS root device volume of the Linux AMI that is used for each EC2 instance.
    Default: - EMR selected default
  - getKerberosAttributes
```
default EmrCreateCluster.KerberosAttributesProperty getKerberosAttributes()
```
    Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.
    Default: - None
  - getLogUri
```
default java.lang.String getLogUri()
```
    The location in Amazon S3 to write the log files of the job flow.
    Default: - None
  - getReleaseLabel
```
default java.lang.String getReleaseLabel()
```
    The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.
    Default: - EMR selected default
  - getScaleDownBehavior
```
default EmrCreateCluster.EmrClusterScaleDownBehavior getScaleDownBehavior()
```
    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
  - getSecurityConfiguration
```
default java.lang.String getSecurityConfiguration()
```
    The name of a security configuration to apply to the cluster.
    Default: - None
  - getServiceRole
```
default IRole getServiceRole()
```
    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.
  - getStepConcurrencyLevel
```
default java.lang.Number getStepConcurrencyLevel()
```
    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
  - getTags
```
default java.util.Map<java.lang.String,java.lang.String> getTags()
```
    A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
    Default: - None
  - getVisibleToAllUsers
```
default java.lang.Boolean getVisibleToAllUsers()
```
    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
  - builder
```
static EmrCreateClusterProps.Builder builder()
```
    Specified by:
    
    builder in interface TaskStateBaseProps
    
    Returns:
    
    a EmrCreateClusterProps.Builder of EmrCreateClusterProps

Interface EmrCreateClusterProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

Method Detail

getInstances

getName

getAdditionalInfo

getApplications

getAutoScalingRole

getBootstrapActions

getClusterRole

getConfigurations

getCustomAmiId

getEbsRootVolumeSize

getKerberosAttributes

getLogUri

getReleaseLabel

getScaleDownBehavior

getSecurityConfiguration

getServiceRole

getStepConcurrencyLevel

getTags

getVisibleToAllUsers

builder