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

Inherits:

Struct

• Object
• Struct
• Aws::EMR::Types::JobFlowDetail

Defined in:

gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb

Overview

A description of a cluster (job flow).

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #ami_version ⇒ String

  Applies only to Amazon EMR AMI versions 3.x and 2.x.

• #auto_scaling_role ⇒ String

  An IAM role for automatic scaling policies.

• #bootstrap_actions ⇒ Array<Types::BootstrapActionDetail>

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

• #execution_status_detail ⇒ Types::JobFlowExecutionStatusDetail

  Describes the execution status of the job flow.

• #instances ⇒ Types::JobFlowInstancesDetail

  Describes the Amazon EC2 instances of the job flow.

• #job_flow_id ⇒ String

  The job flow identifier.

• #job_flow_role ⇒ String

  The IAM role that was specified when the job flow was launched.

• #log_encryption_kms_key_id ⇒ String

  The KMS key used for encrypting log files.

• #log_uri ⇒ String

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

• #name ⇒ String

  The name of the job flow.

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

• #service_role ⇒ String

  The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.

• #steps ⇒ Array<Types::StepDetail>

  A list of steps run by the job flow.

• #supported_products ⇒ Array<String>

  A list of strings set by third-party software when the job flow is launched.

• #visible_to_all_users ⇒ Boolean

  Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster.

Instance Attribute Details

#ami_version ⇒ String

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 3508

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :log_encryption_kms_key_id,
  :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)
  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 a way for the automatic scaling feature to get the required permissions it needs to launch and terminate Amazon EC2 instances in an instance group.

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 3508

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :log_encryption_kms_key_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#bootstrap_actions ⇒ Array<Types::BootstrapActionDetail>

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

Returns:

• (Array<Types::BootstrapActionDetail>)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 3508

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :log_encryption_kms_key_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#execution_status_detail ⇒ Types::JobFlowExecutionStatusDetail

Describes the execution status of the job flow.

Returns:

• (Types::JobFlowExecutionStatusDetail)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 3508

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :log_encryption_kms_key_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#instances ⇒ Types::JobFlowInstancesDetail

Describes the Amazon EC2 instances of the job flow.

Returns:

• (Types::JobFlowInstancesDetail)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 3508

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :log_encryption_kms_key_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#job_flow_id ⇒ String

The job flow identifier.

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 3508

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :log_encryption_kms_key_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#job_flow_role ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 3508

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :log_encryption_kms_key_id,
  :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)
  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 6.0.0.

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 3508

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :log_encryption_kms_key_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#log_uri ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 3508

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :log_encryption_kms_key_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the job flow.

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 3508

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :log_encryption_kms_key_id,
  :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)
  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 available only in Amazon EMR releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 3508

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :log_encryption_kms_key_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#service_role ⇒ String

The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 3508

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :log_encryption_kms_key_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#steps ⇒ Array<Types::StepDetail>

A list of steps run by the job flow.

Returns:

• (Array<Types::StepDetail>)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 3508

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :log_encryption_kms_key_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#supported_products ⇒ Array<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>)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 3508

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :log_encryption_kms_key_id,
  :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)
  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 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 command, or the Amazon Web Services Management Console.

Returns:

• (Boolean)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 3508

class JobFlowDetail < Struct.new(
  :job_flow_id,
  :name,
  :log_uri,
  :log_encryption_kms_key_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end