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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ami_versionString

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)


4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4003

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


4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4003

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_actionsArray<Types::BootstrapActionDetail>

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

Returns:



4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4003

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_detailTypes::JobFlowExecutionStatusDetail

Describes the execution status of the job flow.



4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4003

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

#instancesTypes::JobFlowInstancesDetail

Describes the Amazon EC2 instances of the job flow.



4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4003

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_idString

The job flow identifier.

Returns:

  • (String)


4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4003

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


4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4003

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


4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4003

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_uriString

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

Returns:

  • (String)


4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4003

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

#nameString

The name of the job flow.

Returns:

  • (String)


4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4003

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


4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4003

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_roleString

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

Returns:

  • (String)


4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4003

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

#stepsArray<Types::StepDetail>

A list of steps run by the job flow.

Returns:



4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4003

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


4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4003

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_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 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. IAM principals that are authorized to perform actions on the cluster can use the SetVisibleToAllUsers action to change the value on a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

Returns:

  • (Boolean)


4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4003

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