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

Class: Aws::EMR::Types::JobFlowDetail

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

Overview

A description of a cluster (job flow).

Instance Attribute Summary collapse

Instance Attribute Details

#ami_versionString

Used only for version 2.x and 3.x of Amazon EMR. The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions supported by Amazon EMR, see AMI Versions Supported in EMR in the Amazon EMR Developer Guide.

Returns:

  • (String)


2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 2854

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :ami_version,
  :execution_status_detail,
  :instances,
  :steps,
  :bootstrap_actions,
  :supported_products,
  :visible_to_all_users,
  :job_flow_role,
  :service_role,
  :auto_scaling_role,
  :scale_down_behavior)
  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 a way for the automatic scaling feature to get the required permissions it needs to launch and terminate EC2 instances in an instance group.

Returns:

  • (String)


2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 2854

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :ami_version,
  :execution_status_detail,
  :instances,
  :steps,
  :bootstrap_actions,
  :supported_products,
  :visible_to_all_users,
  :job_flow_role,
  :service_role,
  :auto_scaling_role,
  :scale_down_behavior)
  include Aws::Structure
end

#bootstrap_actionsArray<Types::BootstrapActionDetail>

A list of the bootstrap actions run by the job flow.

Returns:



2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 2854

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :ami_version,
  :execution_status_detail,
  :instances,
  :steps,
  :bootstrap_actions,
  :supported_products,
  :visible_to_all_users,
  :job_flow_role,
  :service_role,
  :auto_scaling_role,
  :scale_down_behavior)
  include Aws::Structure
end

#execution_status_detailTypes::JobFlowExecutionStatusDetail

Describes the execution status of the job flow.



2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 2854

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :ami_version,
  :execution_status_detail,
  :instances,
  :steps,
  :bootstrap_actions,
  :supported_products,
  :visible_to_all_users,
  :job_flow_role,
  :service_role,
  :auto_scaling_role,
  :scale_down_behavior)
  include Aws::Structure
end

#instancesTypes::JobFlowInstancesDetail

Describes the Amazon EC2 instances of the job flow.



2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 2854

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :ami_version,
  :execution_status_detail,
  :instances,
  :steps,
  :bootstrap_actions,
  :supported_products,
  :visible_to_all_users,
  :job_flow_role,
  :service_role,
  :auto_scaling_role,
  :scale_down_behavior)
  include Aws::Structure
end

#job_flow_idString

The job flow identifier.

Returns:

  • (String)


2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 2854

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :ami_version,
  :execution_status_detail,
  :instances,
  :steps,
  :bootstrap_actions,
  :supported_products,
  :visible_to_all_users,
  :job_flow_role,
  :service_role,
  :auto_scaling_role,
  :scale_down_behavior)
  include Aws::Structure
end

#job_flow_roleString

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

Returns:

  • (String)


2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 2854

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :ami_version,
  :execution_status_detail,
  :instances,
  :steps,
  :bootstrap_actions,
  :supported_products,
  :visible_to_all_users,
  :job_flow_role,
  :service_role,
  :auto_scaling_role,
  :scale_down_behavior)
  include Aws::Structure
end

#log_uriString

The location in Amazon S3 where log files for the job are stored.

Returns:

  • (String)


2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 2854

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :ami_version,
  :execution_status_detail,
  :instances,
  :steps,
  :bootstrap_actions,
  :supported_products,
  :visible_to_all_users,
  :job_flow_role,
  :service_role,
  :auto_scaling_role,
  :scale_down_behavior)
  include Aws::Structure
end

#nameString

The name of the job flow.

Returns:

  • (String)


2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 2854

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :ami_version,
  :execution_status_detail,
  :instances,
  :steps,
  :bootstrap_actions,
  :supported_products,
  :visible_to_all_users,
  :job_flow_role,
  :service_role,
  :auto_scaling_role,
  :scale_down_behavior)
  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 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 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)


2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 2854

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :ami_version,
  :execution_status_detail,
  :instances,
  :steps,
  :bootstrap_actions,
  :supported_products,
  :visible_to_all_users,
  :job_flow_role,
  :service_role,
  :auto_scaling_role,
  :scale_down_behavior)
  include Aws::Structure
end

#service_roleString

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

Returns:

  • (String)


2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 2854

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :ami_version,
  :execution_status_detail,
  :instances,
  :steps,
  :bootstrap_actions,
  :supported_products,
  :visible_to_all_users,
  :job_flow_role,
  :service_role,
  :auto_scaling_role,
  :scale_down_behavior)
  include Aws::Structure
end

#stepsArray<Types::StepDetail>

A list of steps run by the job flow.

Returns:



2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 2854

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :ami_version,
  :execution_status_detail,
  :instances,
  :steps,
  :bootstrap_actions,
  :supported_products,
  :visible_to_all_users,
  :job_flow_role,
  :service_role,
  :auto_scaling_role,
  :scale_down_behavior)
  include Aws::Structure
end

#supported_productsArray<String>

A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.

Returns:

  • (Array<String>)


2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 2854

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :ami_version,
  :execution_status_detail,
  :instances,
  :steps,
  :bootstrap_actions,
  :supported_products,
  :visible_to_all_users,
  :job_flow_role,
  :service_role,
  :auto_scaling_role,
  :scale_down_behavior)
  include Aws::Structure
end

#visible_to_all_usersBoolean

Specifies 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 (if they have the proper policy permissions set) manage the cluster. If it is set to false, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

Returns:

  • (Boolean)


2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 2854

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :ami_version,
  :execution_status_detail,
  :instances,
  :steps,
  :bootstrap_actions,
  :supported_products,
  :visible_to_all_users,
  :job_flow_role,
  :service_role,
  :auto_scaling_role,
  :scale_down_behavior)
  include Aws::Structure
end