You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EMR::Types::Cluster

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

The detailed description of the cluster.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#applications ⇒ Array<Types::Application>

The applications installed on this cluster.

Returns:

#auto_scaling_role ⇒ String

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:

  • (String) —

    An IAM role for automatic scaling policies.

#auto_terminate ⇒ Boolean

Specifies whether the cluster should terminate after completing all steps.

Returns:

  • (Boolean) —

    Specifies whether the cluster should terminate after completing all steps.

#cluster_arn ⇒ String

The Amazon Resource Name of the cluster.

Returns:

  • (String) —

    The Amazon Resource Name of the cluster.

#configurations ⇒ Array<Types::Configuration>

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

Returns:

#custom_ami_id ⇒ String

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:

  • (String) —

    Available only in Amazon EMR version 5.7.0 and later.

#ebs_root_volume_size ⇒ Integer

The size, in GiB, of the 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:

  • (Integer) —

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

#ec2_instance_attributes ⇒ Types::Ec2InstanceAttributes

Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.

Returns:

#id ⇒ String

The unique identifier for the cluster.

Returns:

  • (String) —

    The unique identifier for the cluster.

#instance_collection_type ⇒ String

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.

Possible values:

  • INSTANCE_FLEET
  • INSTANCE_GROUP

Returns:

  • (String) —

    The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

#kerberos_attributes ⇒ Types::KerberosAttributes

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

Returns:

  • (Types::KerberosAttributes) —

    Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.

#log_encryption_kms_key_id ⇒ String

The AWS KMS customer master key (CMK) used for encrypting log files. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

Returns:

  • (String) —

    The AWS KMS customer master key (CMK) used for encrypting log files.

#log_uri ⇒ String

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

Returns:

  • (String) —

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

#master_public_dns_name ⇒ String

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

Returns:

  • (String) —

    The DNS name of the master node.

#name ⇒ String

The name of the cluster.

Returns:

  • (String) —

    The name of the cluster.

#normalized_instance_hours ⇒ Integer

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

Returns:

  • (Integer) —

    An approximation of the cost of the cluster, represented in m1.small/hours.

#outpost_arn ⇒ String

The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.

#placement_groups ⇒ Array<Types::PlacementGroupConfig>

Placement group configured for an Amazon EMR cluster.

Returns:

#release_label ⇒ String

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.

Returns:

  • (String) —

    The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.

#repo_upgrade_on_boot ⇒ String

Applies only when CustomAmiID is used. Specifies the type of updates that are applied from the Amazon Linux AMI package repositories when an instance boots using the AMI.

Possible values:

  • SECURITY
  • NONE

Returns:

  • (String) —

    Applies only when CustomAmiID is used.

#requested_ami_version ⇒ String

The AMI version requested for this cluster.

Returns:

  • (String) —

    The AMI version requested for this cluster.

#running_ami_version ⇒ String

The AMI version running on this cluster.

Returns:

  • (String) —

    The AMI version running on this cluster.

#scale_down_behavior ⇒ String

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 blacklists 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.

Possible values:

  • TERMINATE_AT_INSTANCE_HOUR
  • TERMINATE_AT_TASK_COMPLETION

Returns:

  • (String) —

    The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.

#security_configuration ⇒ String

The name of the security configuration applied to the cluster.

Returns:

  • (String) —

    The name of the security configuration applied to the cluster.

#service_role ⇒ String

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

Returns:

  • (String) —

    The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

#status ⇒ Types::ClusterStatus

The current status details about the cluster.

Returns:

#step_concurrency_level ⇒ Integer

Specifies the number of steps that can be executed concurrently.

Returns:

  • (Integer) —

    Specifies the number of steps that can be executed concurrently.

#tags ⇒ Array<Types::Tag>

A list of tags associated with a cluster.

Returns:

  • (Array<Types::Tag>) —

    A list of tags associated with a cluster.

#termination_protected ⇒ Boolean

Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.

Returns:

  • (Boolean) —

    Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.

#visible_to_all_users ⇒ Boolean

Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. The default value, true, indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. If this value is false, only the IAM user that created the cluster can perform actions. This value can be changed on a running cluster by using the SetVisibleToAllUsers action. You can override the default value of true when you create a cluster by using the VisibleToAllUsers parameter of the RunJobFlow action.

Returns:

  • (Boolean) —

    Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster.