CfnClusterProps

class aws_cdk.aws_emr.CfnClusterProps(*, instances, job_flow_role, name, service_role, additional_info=None, applications=None, auto_scaling_role=None, auto_termination_policy=None, bootstrap_actions=None, configurations=None, custom_ami_id=None, ebs_root_volume_iops=None, ebs_root_volume_size=None, ebs_root_volume_throughput=None, kerberos_attributes=None, log_encryption_kms_key_id=None, log_uri=None, managed_scaling_policy=None, os_release_label=None, placement_group_configs=None, release_label=None, scale_down_behavior=None, security_configuration=None, step_concurrency_level=None, steps=None, tags=None, visible_to_all_users=None)

Bases: object

Properties for defining a CfnCluster.

Parameters:
  • instances (Union[IResolvable, JobFlowInstancesConfigProperty, Dict[str, Any]]) – A specification of the number and type of Amazon EC2 instances.

  • job_flow_role (str) – Also called instance profile and Amazon EC2 role. An IAM role for an Amazon EMR cluster. The Amazon 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 AWS CLI or console.

  • name (str) – The name of the cluster. This parameter can’t contain the characters <, >, $, |, or ` (backtick).

  • service_role (str) – The IAM role that Amazon EMR assumes in order to access AWS resources on your behalf.

  • additional_info (Optional[Any]) – A JSON string for selecting additional features.

  • applications (Union[IResolvable, Sequence[Union[IResolvable, ApplicationProperty, Dict[str, Any]]], None]) – The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on.

  • auto_scaling_role (Optional[str]) – 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 Amazon EC2 instances in an instance group.

  • auto_termination_policy (Union[IResolvable, AutoTerminationPolicyProperty, Dict[str, Any], None]) – An auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination .

  • bootstrap_actions (Union[IResolvable, Sequence[Union[IResolvable, BootstrapActionConfigProperty, Dict[str, Any]]], None]) – A list of bootstrap actions to run before Hadoop starts on the cluster nodes.

  • configurations (Union[IResolvable, Sequence[Union[IResolvable, ConfigurationProperty, Dict[str, Any]]], None]) – Applies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster.

  • custom_ami_id (Optional[str]) – Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

  • ebs_root_volume_iops (Union[int, float, None]) – The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.

  • ebs_root_volume_size (Union[int, float, None]) – The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and later.

  • ebs_root_volume_throughput (Union[int, float, None]) – The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.

  • kerberos_attributes (Union[IResolvable, KerberosAttributesProperty, Dict[str, Any], None]) – 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 .

  • log_encryption_kms_key_id (Optional[str]) – The AWS KMS key used for encrypting log files. This attribute is only available with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0.

  • log_uri (Optional[str]) – The path to the Amazon S3 location where logs for this cluster are stored.

  • managed_scaling_policy (Union[IResolvable, ManagedScalingPolicyProperty, Dict[str, Any], None]) – Creates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling policy defines the limits for resources, such as Amazon 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.

  • os_release_label (Optional[str]) – The Amazon Linux release specified in a cluster launch RunJobFlow request. If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response.

  • placement_group_configs (Union[IResolvable, Sequence[Union[IResolvable, PlacementGroupConfigProperty, Dict[str, Any]]], None])

  • release_label (Optional[str]) – 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 ` <https://docs.aws.amazon.com/emr/latest/ReleaseGuide/>`_ . The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion .

  • scale_down_behavior (Optional[str]) – 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 releases 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

  • security_configuration (Optional[str]) – The name of the security configuration applied to the cluster.

  • step_concurrency_level (Union[int, float, None]) – Specifies the number of steps that can be executed concurrently. The default value is 1 . The maximum value is 256 .

  • steps (Union[IResolvable, Sequence[Union[IResolvable, StepConfigProperty, Dict[str, Any]]], None]) – A list of steps to run.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tags associated with a cluster.

  • visible_to_all_users (Union[bool, IResolvable, None]) – 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. .. epigraph:: 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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
additional_info

A JSON string for selecting additional features.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-additionalinfo

applications

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-applications

auto_scaling_role

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 Amazon EC2 instances in an instance group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-autoscalingrole

auto_termination_policy

An auto-termination policy for an Amazon EMR cluster.

An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-autoterminationpolicy

bootstrap_actions

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-bootstrapactions

configurations

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-configurations

custom_ami_id

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-customamiid

ebs_root_volume_iops

The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.

Available in Amazon EMR releases 6.15.0 and later.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-ebsrootvolumeiops

ebs_root_volume_size

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.

Available in Amazon EMR releases 4.x and later.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-ebsrootvolumesize

ebs_root_volume_throughput

The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance.

Available in Amazon EMR releases 6.15.0 and later.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-ebsrootvolumethroughput

instances

A specification of the number and type of Amazon EC2 instances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-instances

job_flow_role

Also called instance profile and Amazon EC2 role.

An IAM role for an Amazon EMR cluster. The Amazon 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 AWS CLI or console.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-jobflowrole

kerberos_attributes

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-kerberosattributes

log_encryption_kms_key_id

The AWS KMS key used for encrypting log files.

This attribute is only available with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-logencryptionkmskeyid

log_uri

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-loguri

managed_scaling_policy

Creates or updates a managed scaling policy for an Amazon EMR cluster.

The managed scaling policy defines the limits for resources, such as Amazon 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-managedscalingpolicy

name

The name of the cluster.

This parameter can’t contain the characters <, >, $, |, or ` (backtick).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-name

os_release_label

The Amazon Linux release specified in a cluster launch RunJobFlow request.

If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-osreleaselabel

placement_group_configs

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-placementgroupconfigs

Type:

see

release_label

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 ` <https://docs.aws.amazon.com/emr/latest/ReleaseGuide/>`_ . The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-releaselabel

scale_down_behavior

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 releases 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-scaledownbehavior

security_configuration

The name of the security configuration applied to the cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-securityconfiguration

service_role

The IAM role that Amazon EMR assumes in order to access AWS resources on your behalf.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-servicerole

step_concurrency_level

Specifies the number of steps that can be executed concurrently.

The default value is 1 . The maximum value is 256 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-stepconcurrencylevel

steps

A list of steps to run.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-steps

tags

A list of tags associated with a cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-tags

visible_to_all_users

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. .. epigraph:

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`` .
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-cluster.html#cfn-emr-cluster-visibletoallusers