software.amazon.awscdk.services.emr

Class CfnClusterProps.Builder

java.lang.Object

software.amazon.awscdk.services.emr.CfnClusterProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnClusterProps>

Enclosing interface:

CfnClusterProps

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

A builder for CfnClusterProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnClusterProps.Builder	additionalInfo(Object additionalInfo) Sets the value of CfnClusterProps.getAdditionalInfo()
CfnClusterProps.Builder	applications(IResolvable applications) Sets the value of CfnClusterProps.getApplications()
CfnClusterProps.Builder	applications(List<? extends Object> applications) Sets the value of CfnClusterProps.getApplications()
CfnClusterProps.Builder	autoScalingRole(String autoScalingRole) Sets the value of CfnClusterProps.getAutoScalingRole()
CfnClusterProps.Builder	autoTerminationPolicy(CfnCluster.AutoTerminationPolicyProperty autoTerminationPolicy) Sets the value of CfnClusterProps.getAutoTerminationPolicy()
CfnClusterProps.Builder	autoTerminationPolicy(IResolvable autoTerminationPolicy) Sets the value of CfnClusterProps.getAutoTerminationPolicy()
CfnClusterProps.Builder	bootstrapActions(IResolvable bootstrapActions) Sets the value of CfnClusterProps.getBootstrapActions()
CfnClusterProps.Builder	bootstrapActions(List<? extends Object> bootstrapActions) Sets the value of CfnClusterProps.getBootstrapActions()
CfnClusterProps	build() Builds the configured instance.
CfnClusterProps.Builder	configurations(IResolvable configurations) Sets the value of CfnClusterProps.getConfigurations()
CfnClusterProps.Builder	configurations(List<? extends Object> configurations) Sets the value of CfnClusterProps.getConfigurations()
CfnClusterProps.Builder	customAmiId(String customAmiId) Sets the value of CfnClusterProps.getCustomAmiId()
CfnClusterProps.Builder	ebsRootVolumeSize(Number ebsRootVolumeSize) Sets the value of CfnClusterProps.getEbsRootVolumeSize()
CfnClusterProps.Builder	instances(CfnCluster.JobFlowInstancesConfigProperty instances) Sets the value of CfnClusterProps.getInstances()
CfnClusterProps.Builder	instances(IResolvable instances) Sets the value of CfnClusterProps.getInstances()
CfnClusterProps.Builder	jobFlowRole(String jobFlowRole) Sets the value of CfnClusterProps.getJobFlowRole()
CfnClusterProps.Builder	kerberosAttributes(CfnCluster.KerberosAttributesProperty kerberosAttributes) Sets the value of CfnClusterProps.getKerberosAttributes()
CfnClusterProps.Builder	kerberosAttributes(IResolvable kerberosAttributes) Sets the value of CfnClusterProps.getKerberosAttributes()
CfnClusterProps.Builder	logEncryptionKmsKeyId(String logEncryptionKmsKeyId) Sets the value of CfnClusterProps.getLogEncryptionKmsKeyId()
CfnClusterProps.Builder	logUri(String logUri) Sets the value of CfnClusterProps.getLogUri()
CfnClusterProps.Builder	managedScalingPolicy(CfnCluster.ManagedScalingPolicyProperty managedScalingPolicy) Sets the value of CfnClusterProps.getManagedScalingPolicy()
CfnClusterProps.Builder	managedScalingPolicy(IResolvable managedScalingPolicy) Sets the value of CfnClusterProps.getManagedScalingPolicy()
CfnClusterProps.Builder	name(String name) Sets the value of CfnClusterProps.getName()
CfnClusterProps.Builder	releaseLabel(String releaseLabel) Sets the value of CfnClusterProps.getReleaseLabel()
CfnClusterProps.Builder	scaleDownBehavior(String scaleDownBehavior) Sets the value of CfnClusterProps.getScaleDownBehavior()
CfnClusterProps.Builder	securityConfiguration(String securityConfiguration) Sets the value of CfnClusterProps.getSecurityConfiguration()
CfnClusterProps.Builder	serviceRole(String serviceRole) Sets the value of CfnClusterProps.getServiceRole()
CfnClusterProps.Builder	stepConcurrencyLevel(Number stepConcurrencyLevel) Sets the value of CfnClusterProps.getStepConcurrencyLevel()
CfnClusterProps.Builder	steps(IResolvable steps) Sets the value of CfnClusterProps.getSteps()
CfnClusterProps.Builder	steps(List<? extends Object> steps) Sets the value of CfnClusterProps.getSteps()
CfnClusterProps.Builder	tags(List<? extends CfnTag> tags) Sets the value of CfnClusterProps.getTags()
CfnClusterProps.Builder	visibleToAllUsers(Boolean visibleToAllUsers) Sets the value of CfnClusterProps.getVisibleToAllUsers()
CfnClusterProps.Builder	visibleToAllUsers(IResolvable visibleToAllUsers) Sets the value of CfnClusterProps.getVisibleToAllUsers()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

instances

@Stability(value=Stable)
public CfnClusterProps.Builder instances(CfnCluster.JobFlowInstancesConfigProperty instances)

Sets the value of CfnClusterProps.getInstances()

Parameters:

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

Returns:

this

instances

@Stability(value=Stable)
public CfnClusterProps.Builder instances(IResolvable instances)

Sets the value of CfnClusterProps.getInstances()

Parameters:

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

Returns:

this

jobFlowRole

@Stability(value=Stable)
public CfnClusterProps.Builder jobFlowRole(String jobFlowRole)

Sets the value of CfnClusterProps.getJobFlowRole()

Parameters:

jobFlowRole - Also called instance profile and EC2 role. This parameter is required. An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole . In order to use the default role, you must have already created it using the CLI or console.

Returns:

this

name

@Stability(value=Stable)
public CfnClusterProps.Builder name(String name)

Sets the value of CfnClusterProps.getName()

Parameters:

name - The name of the cluster. This parameter is required.

Returns:

this

serviceRole

@Stability(value=Stable)
public CfnClusterProps.Builder serviceRole(String serviceRole)

Sets the value of CfnClusterProps.getServiceRole()

Parameters:

serviceRole - The IAM role that Amazon EMR assumes in order to access AWS resources on your behalf. This parameter is required.

Returns:

this

additionalInfo

@Stability(value=Stable)
public CfnClusterProps.Builder additionalInfo(Object additionalInfo)

Sets the value of CfnClusterProps.getAdditionalInfo()

Parameters:

additionalInfo - A JSON string for selecting additional features.

Returns:

this

applications

@Stability(value=Stable)
public CfnClusterProps.Builder applications(IResolvable applications)

Sets the value of CfnClusterProps.getApplications()

Parameters:

applications - The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.

Returns:

this

applications

@Stability(value=Stable)
public CfnClusterProps.Builder applications(List<? extends Object> applications)

Sets the value of CfnClusterProps.getApplications()

Parameters:

applications - The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.

Returns:

this

autoScalingRole

@Stability(value=Stable)
public CfnClusterProps.Builder autoScalingRole(String autoScalingRole)

Sets the value of CfnClusterProps.getAutoScalingRole()

Parameters:

autoScalingRole - An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole . The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

Returns:

this

autoTerminationPolicy

@Stability(value=Stable)
public CfnClusterProps.Builder autoTerminationPolicy(CfnCluster.AutoTerminationPolicyProperty autoTerminationPolicy)

Sets the value of CfnClusterProps.getAutoTerminationPolicy()

Parameters:

autoTerminationPolicy - `AWS::EMR::Cluster.AutoTerminationPolicy`.

Returns:

this

autoTerminationPolicy

@Stability(value=Stable)
public CfnClusterProps.Builder autoTerminationPolicy(IResolvable autoTerminationPolicy)

Sets the value of CfnClusterProps.getAutoTerminationPolicy()

Parameters:

autoTerminationPolicy - `AWS::EMR::Cluster.AutoTerminationPolicy`.

Returns:

this

bootstrapActions

@Stability(value=Stable)
public CfnClusterProps.Builder bootstrapActions(IResolvable bootstrapActions)

Sets the value of CfnClusterProps.getBootstrapActions()

Parameters:

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

Returns:

this

bootstrapActions

@Stability(value=Stable)
public CfnClusterProps.Builder bootstrapActions(List<? extends Object> bootstrapActions)

Sets the value of CfnClusterProps.getBootstrapActions()

Parameters:

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

Returns:

this

configurations

@Stability(value=Stable)
public CfnClusterProps.Builder configurations(IResolvable configurations)

Sets the value of CfnClusterProps.getConfigurations()

Parameters:

configurations - Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.

Returns:

this

configurations

@Stability(value=Stable)
public CfnClusterProps.Builder configurations(List<? extends Object> configurations)

Sets the value of CfnClusterProps.getConfigurations()

Parameters:

configurations - Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.

Returns:

this

customAmiId

@Stability(value=Stable)
public CfnClusterProps.Builder customAmiId(String customAmiId)

Sets the value of CfnClusterProps.getCustomAmiId()

Parameters:

customAmiId - Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

Returns:

this

ebsRootVolumeSize

@Stability(value=Stable)
public CfnClusterProps.Builder ebsRootVolumeSize(Number ebsRootVolumeSize)

Sets the value of CfnClusterProps.getEbsRootVolumeSize()

Parameters:

ebsRootVolumeSize - The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.

Returns:

this

kerberosAttributes

@Stability(value=Stable)
public CfnClusterProps.Builder kerberosAttributes(CfnCluster.KerberosAttributesProperty kerberosAttributes)

Sets the value of CfnClusterProps.getKerberosAttributes()

Parameters:

kerberosAttributes - Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide .

Returns:

this

kerberosAttributes

@Stability(value=Stable)
public CfnClusterProps.Builder kerberosAttributes(IResolvable kerberosAttributes)

Sets the value of CfnClusterProps.getKerberosAttributes()

Parameters:

kerberosAttributes - Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide .

Returns:

this

logEncryptionKmsKeyId

@Stability(value=Stable)
public CfnClusterProps.Builder logEncryptionKmsKeyId(String logEncryptionKmsKeyId)

Sets the value of CfnClusterProps.getLogEncryptionKmsKeyId()

Parameters:

logEncryptionKmsKeyId - The AWS KMS key used for encrypting log files. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

Returns:

this

logUri

@Stability(value=Stable)
public CfnClusterProps.Builder logUri(String logUri)

Sets the value of CfnClusterProps.getLogUri()

Parameters:

logUri - The path to the Amazon S3 location where logs for this cluster are stored.

Returns:

this

managedScalingPolicy

@Stability(value=Stable)
public CfnClusterProps.Builder managedScalingPolicy(CfnCluster.ManagedScalingPolicyProperty managedScalingPolicy)

Sets the value of CfnClusterProps.getManagedScalingPolicy()

Parameters:

managedScalingPolicy - Creates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling policy defines the limits for resources, such as EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.

Returns:

this

managedScalingPolicy

@Stability(value=Stable)
public CfnClusterProps.Builder managedScalingPolicy(IResolvable managedScalingPolicy)

Sets the value of CfnClusterProps.getManagedScalingPolicy()

Parameters:

managedScalingPolicy - Creates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling policy defines the limits for resources, such as EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration.

Returns:

this

releaseLabel

@Stability(value=Stable)
public CfnClusterProps.Builder releaseLabel(String releaseLabel)

Sets the value of CfnClusterProps.getReleaseLabel()

Parameters:

releaseLabel - The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x , where x.x.x is an Amazon EMR release version such as emr-5.14.0 . For more information about Amazon EMR release versions and included application versions and features, see . The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion .

Returns:

this

scaleDownBehavior

@Stability(value=Stable)
public CfnClusterProps.Builder scaleDownBehavior(String scaleDownBehavior)

Sets the value of CfnClusterProps.getScaleDownBehavior()

Parameters:

scaleDownBehavior - The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

Returns:

this

securityConfiguration

@Stability(value=Stable)
public CfnClusterProps.Builder securityConfiguration(String securityConfiguration)

Sets the value of CfnClusterProps.getSecurityConfiguration()

Parameters:

securityConfiguration - The name of the security configuration applied to the cluster.

Returns:

this

stepConcurrencyLevel

@Stability(value=Stable)
public CfnClusterProps.Builder stepConcurrencyLevel(Number stepConcurrencyLevel)

Sets the value of CfnClusterProps.getStepConcurrencyLevel()

Parameters:

stepConcurrencyLevel - Specifies the number of steps that can be executed concurrently. The default value is 1 . The maximum value is 256 .

Returns:

this

steps

@Stability(value=Stable)
public CfnClusterProps.Builder steps(IResolvable steps)

Sets the value of CfnClusterProps.getSteps()

Parameters:

steps - A list of steps to run.

Returns:

this

steps

@Stability(value=Stable)
public CfnClusterProps.Builder steps(List<? extends Object> steps)

Sets the value of CfnClusterProps.getSteps()

Parameters:

steps - A list of steps to run.

Returns:

this

tags

@Stability(value=Stable)
public CfnClusterProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnClusterProps.getTags()

Parameters:

tags - A list of tags associated with a cluster.

Returns:

this

visibleToAllUsers

@Stability(value=Stable)
public CfnClusterProps.Builder visibleToAllUsers(Boolean visibleToAllUsers)

Sets the value of CfnClusterProps.getVisibleToAllUsers()

Parameters:

visibleToAllUsers - Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to true , all IAM users of that AWS account can view and manage the cluster if they have the proper policy permissions set. If this value is false , only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

When you create clusters directly through the EMR console or API, this value is set to true by default. However, for AWS::EMR::Cluster resources in CloudFormation, the default is false .

Returns:

this

visibleToAllUsers

@Stability(value=Stable)
public CfnClusterProps.Builder visibleToAllUsers(IResolvable visibleToAllUsers)

Sets the value of CfnClusterProps.getVisibleToAllUsers()

Parameters:

visibleToAllUsers - Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to true , all IAM users of that AWS account can view and manage the cluster if they have the proper policy permissions set. If this value is false , only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

When you create clusters directly through the EMR console or API, this value is set to true by default. However, for AWS::EMR::Cluster resources in CloudFormation, the default is false .

Returns:

this

build

@Stability(value=Stable)
public CfnClusterProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnClusterProps

Throws:

NullPointerException - if any required attribute was not provided