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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-emr/types.rb

Overview

The detailed description of the cluster.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#applications ⇒ Array<Types::Application>

The applications installed on this cluster.

Returns:



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#auto_terminate ⇒ Boolean

Specifies whether the cluster should terminate after completing all steps.

Returns:

  • (Boolean) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_arn ⇒ String

The Amazon Resource Name of the cluster.

Returns:

  • (String) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#configurations ⇒ Array<Types::Configuration>

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

Returns:



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#custom_ami_id ⇒ String

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.

Returns:

  • (String) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#ebs_root_volume_iops ⇒ Integer

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.

Returns:

  • (Integer) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#ebs_root_volume_size ⇒ Integer

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.

Returns:

  • (Integer) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#ebs_root_volume_throughput ⇒ Integer

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.

Returns:

  • (Integer) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_instance_attributes ⇒ Types::Ec2InstanceAttributes

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

Returns:



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique identifier for the cluster.

Returns:

  • (String) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#instance_collection_type ⇒ String

<note markdown=“1”> The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.

</note>

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.

Returns:

  • (String) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#kerberos_attributes ⇒ Types::KerberosAttributes

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see

Use Kerberos Authentication][1

in the *Amazon EMR Management

Guide*.

[1]: docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html

Returns:



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#log_encryption_kms_key_id ⇒ String

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

Returns:

  • (String) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#log_uri ⇒ String

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

Returns:

  • (String) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#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) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the cluster. This parameter can’t contain the characters &lt;, &gt;, $, |, or ‘ (backtick).

Returns:

  • (String) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#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 Amazon 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) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#os_release_label ⇒ String

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.

Returns:

  • (String) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#outpost_arn ⇒ String

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

Returns:

  • (String) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#placement_groups ⇒ Array<Types::PlacementGroupConfig>

Placement group configured for an Amazon EMR cluster.

Returns:



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/emr/latest/ReleaseGuide/

Returns:

  • (String) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#repo_upgrade_on_boot ⇒ String

Applies only when ‘CustomAmiID` is used. Specifies the type of updates that the Amazon Linux AMI package repositories apply when an instance boots using the AMI.

Returns:

  • (String) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#requested_ami_version ⇒ String

The AMI version requested for this cluster.

Returns:

  • (String) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#running_ami_version ⇒ String

The AMI version running on this cluster.

Returns:

  • (String) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#security_configuration ⇒ String

The name of the security configuration applied to the cluster.

Returns:

  • (String) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#service_role ⇒ String

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

Returns:

  • (String) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ Types::ClusterStatus

The current status details about the cluster.

Returns:



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#step_concurrency_level ⇒ Integer

Specifies the number of steps that can be executed concurrently.

Returns:

  • (Integer) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of tags associated with a cluster.

Returns:



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#termination_protected ⇒ Boolean

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

Returns:

  • (Boolean) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#unhealthy_node_replacement ⇒ Boolean

Indicates whether Amazon EMR should gracefully replace Amazon EC2 core instances that have degraded within the cluster.

Returns:

  • (Boolean) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#visible_to_all_users ⇒ Boolean

Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When ‘true`, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions on the cluster that their IAM policies allow. When `false`, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.

The default value is ‘true` if a value is not provided when creating a cluster using the Amazon EMR API RunJobFlow command, the CLI

create-cluster][1

command, or the Amazon Web Services Management

Console.

[1]: docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html

Returns:

  • (Boolean) 


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/aws-sdk-emr/types.rb', line 799

class Cluster < Struct.new(
  :id,
  :name,
  :status,
  :ec2_instance_attributes,
  :instance_collection_type,
  :log_uri,
  :log_encryption_kms_key_id,
  :requested_ami_version,
  :running_ami_version,
  :release_label,
  :auto_terminate,
  :termination_protected,
  :unhealthy_node_replacement,
  :visible_to_all_users,
  :applications,
  :tags,
  :service_role,
  :normalized_instance_hours,
  :master_public_dns_name,
  :configurations,
  :security_configuration,
  :auto_scaling_role,
  :scale_down_behavior,
  :custom_ami_id,
  :ebs_root_volume_size,
  :repo_upgrade_on_boot,
  :kerberos_attributes,
  :cluster_arn,
  :outpost_arn,
  :step_concurrency_level,
  :placement_groups,
  :os_release_label,
  :ebs_root_volume_iops,
  :ebs_root_volume_throughput)
  SENSITIVE = []
  include Aws::Structure
end