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

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

Overview

The detailed description of the cluster.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#applicationsArray<Types::Application>

The applications installed on this cluster.

Returns:



780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#auto_scaling_roleString

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)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#auto_terminateBoolean

Specifies whether the cluster should terminate after completing all steps.

Returns:

  • (Boolean)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_arnString

The Amazon Resource Name of the cluster.

Returns:

  • (String)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#configurationsArray<Types::Configuration>

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

Returns:



780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#custom_ami_idString

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)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#ebs_root_volume_sizeInteger

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:

  • (Integer)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

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



780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The unique identifier for the cluster.

Returns:

  • (String)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#instance_collection_typeString

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.

Returns:

  • (String)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

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



780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#log_encryption_kms_key_idString

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

  • (String)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#log_uriString

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

Returns:

  • (String)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#master_public_dns_nameString

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)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the cluster.

Returns:

  • (String)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#normalized_instance_hoursInteger

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)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#os_release_labelString

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)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#outpost_arnString

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

Returns:

  • (String)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#placement_groupsArray<Types::PlacementGroupConfig>

Placement group configured for an Amazon EMR cluster.

Returns:



780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#release_labelString

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)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#repo_upgrade_on_bootString

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.

Returns:

  • (String)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#requested_ami_versionString

The AMI version requested for this cluster.

Returns:

  • (String)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#running_ami_versionString

The AMI version running on this cluster.

Returns:

  • (String)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#scale_down_behaviorString

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:

  • (String)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#security_configurationString

The name of the security configuration applied to the cluster.

Returns:

  • (String)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#service_roleString

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

Returns:

  • (String)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#statusTypes::ClusterStatus

The current status details about the cluster.



780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#step_concurrency_levelInteger

Specifies the number of steps that can be executed concurrently.

Returns:

  • (Integer)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of tags associated with a cluster.

Returns:



780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#termination_protectedBoolean

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)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#visible_to_all_usersBoolean

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 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 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 EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console.

Returns:

  • (Boolean)


780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 780

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,
  :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)
  SENSITIVE = []
  include Aws::Structure
end