Class: Aws::EMR::Types::JobFlowInstancesConfig

Inherits:

Struct

• Object
• Struct
• Aws::EMR::Types::JobFlowInstancesConfig

Defined in:

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

Overview

A description of the Amazon EC2 instance on which the cluster (job flow) runs. A valid JobFlowInstancesConfig must contain either InstanceGroups or InstanceFleets. They cannot be used together. You may also have MasterInstanceType, SlaveInstanceType, and InstanceCount (all three must be present), but we don't recommend this configuration.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #additional_master_security_groups ⇒ Array<String>

  A list of additional Amazon EC2 security group IDs for the master node.

• #additional_slave_security_groups ⇒ Array<String>

  A list of additional Amazon EC2 security group IDs for the core and task nodes.

• #ec2_key_name ⇒ String

  The name of the EC2 key pair that can be used to connect to the master node using SSH as the user called "hadoop.".

• #ec2_subnet_id ⇒ String

  Applies to clusters that use the uniform instance group configuration.

• #ec2_subnet_ids ⇒ Array<String>

  Applies to clusters that use the instance fleet configuration.

• #emr_managed_master_security_group ⇒ String

  The identifier of the Amazon EC2 security group for the master node.

• #emr_managed_slave_security_group ⇒ String

  The identifier of the Amazon EC2 security group for the core and task nodes.

• #hadoop_version ⇒ String

  Applies only to Amazon EMR release versions earlier than 4.0.

• #instance_count ⇒ Integer

  The number of EC2 instances in the cluster.

• #instance_fleets ⇒ Array<Types::InstanceFleetConfig>

  The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

• #instance_groups ⇒ Array<Types::InstanceGroupConfig>

  Configuration for the instance groups in a cluster.

• #keep_job_flow_alive_when_no_steps ⇒ Boolean

  Specifies whether the cluster should remain available after completing all steps.

• #master_instance_type ⇒ String

  The EC2 instance type of the master node.

• #placement ⇒ Types::PlacementType

  The Availability Zone in which the cluster runs.

• #service_access_security_group ⇒ String

  The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

• #slave_instance_type ⇒ String

  The EC2 instance type of the core and task nodes.

• #termination_protected ⇒ Boolean

  Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error.

Instance Attribute Details

#additional_master_security_groups ⇒ Array<String>

A list of additional Amazon EC2 security group IDs for the master node.

Returns:

• (Array<String>)

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

class JobFlowInstancesConfig < Struct.new(
  :master_instance_type,
  :slave_instance_type,
  :instance_count,
  :instance_groups,
  :instance_fleets,
  :ec2_key_name,
  :placement,
  :keep_job_flow_alive_when_no_steps,
  :termination_protected,
  :hadoop_version,
  :ec2_subnet_id,
  :ec2_subnet_ids,
  :emr_managed_master_security_group,
  :emr_managed_slave_security_group,
  :service_access_security_group,
  :additional_master_security_groups,
  :additional_slave_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#additional_slave_security_groups ⇒ Array<String>

A list of additional Amazon EC2 security group IDs for the core and task nodes.

Returns:

• (Array<String>)

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

class JobFlowInstancesConfig < Struct.new(
  :master_instance_type,
  :slave_instance_type,
  :instance_count,
  :instance_groups,
  :instance_fleets,
  :ec2_key_name,
  :placement,
  :keep_job_flow_alive_when_no_steps,
  :termination_protected,
  :hadoop_version,
  :ec2_subnet_id,
  :ec2_subnet_ids,
  :emr_managed_master_security_group,
  :emr_managed_slave_security_group,
  :service_access_security_group,
  :additional_master_security_groups,
  :additional_slave_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_key_name ⇒ String

The name of the EC2 key pair that can be used to connect to the master node using SSH as the user called "hadoop."

Returns:

• (String)

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

class JobFlowInstancesConfig < Struct.new(
  :master_instance_type,
  :slave_instance_type,
  :instance_count,
  :instance_groups,
  :instance_fleets,
  :ec2_key_name,
  :placement,
  :keep_job_flow_alive_when_no_steps,
  :termination_protected,
  :hadoop_version,
  :ec2_subnet_id,
  :ec2_subnet_ids,
  :emr_managed_master_security_group,
  :emr_managed_slave_security_group,
  :service_access_security_group,
  :additional_master_security_groups,
  :additional_slave_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_subnet_id ⇒ String

Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value and your account supports EC2-Classic, the cluster launches in EC2-Classic.

Returns:

• (String)

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

class JobFlowInstancesConfig < Struct.new(
  :master_instance_type,
  :slave_instance_type,
  :instance_count,
  :instance_groups,
  :instance_fleets,
  :ec2_key_name,
  :placement,
  :keep_job_flow_alive_when_no_steps,
  :termination_protected,
  :hadoop_version,
  :ec2_subnet_id,
  :ec2_subnet_ids,
  :emr_managed_master_security_group,
  :emr_managed_slave_security_group,
  :service_access_security_group,
  :additional_master_security_groups,
  :additional_slave_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_subnet_ids ⇒ Array<String>

Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

Returns:

• (Array<String>)

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

class JobFlowInstancesConfig < Struct.new(
  :master_instance_type,
  :slave_instance_type,
  :instance_count,
  :instance_groups,
  :instance_fleets,
  :ec2_key_name,
  :placement,
  :keep_job_flow_alive_when_no_steps,
  :termination_protected,
  :hadoop_version,
  :ec2_subnet_id,
  :ec2_subnet_ids,
  :emr_managed_master_security_group,
  :emr_managed_slave_security_group,
  :service_access_security_group,
  :additional_master_security_groups,
  :additional_slave_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#emr_managed_master_security_group ⇒ String

The identifier of the Amazon EC2 security group for the master node. If you specify EmrManagedMasterSecurityGroup, you must also specify EmrManagedSlaveSecurityGroup.

Returns:

• (String)

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

class JobFlowInstancesConfig < Struct.new(
  :master_instance_type,
  :slave_instance_type,
  :instance_count,
  :instance_groups,
  :instance_fleets,
  :ec2_key_name,
  :placement,
  :keep_job_flow_alive_when_no_steps,
  :termination_protected,
  :hadoop_version,
  :ec2_subnet_id,
  :ec2_subnet_ids,
  :emr_managed_master_security_group,
  :emr_managed_slave_security_group,
  :service_access_security_group,
  :additional_master_security_groups,
  :additional_slave_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#emr_managed_slave_security_group ⇒ String

The identifier of the Amazon EC2 security group for the core and task nodes. If you specify EmrManagedSlaveSecurityGroup, you must also specify EmrManagedMasterSecurityGroup.

Returns:

• (String)

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

class JobFlowInstancesConfig < Struct.new(
  :master_instance_type,
  :slave_instance_type,
  :instance_count,
  :instance_groups,
  :instance_fleets,
  :ec2_key_name,
  :placement,
  :keep_job_flow_alive_when_no_steps,
  :termination_protected,
  :hadoop_version,
  :ec2_subnet_id,
  :ec2_subnet_ids,
  :emr_managed_master_security_group,
  :emr_managed_slave_security_group,
  :service_access_security_group,
  :additional_master_security_groups,
  :additional_slave_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#hadoop_version ⇒ String

Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster. Valid inputs are "0.18" (no longer maintained), "0.20" (no longer maintained), "0.20.205" (no longer maintained), "1.0.3", "2.2.0", or "2.4.0". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.

Returns:

• (String)

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

class JobFlowInstancesConfig < Struct.new(
  :master_instance_type,
  :slave_instance_type,
  :instance_count,
  :instance_groups,
  :instance_fleets,
  :ec2_key_name,
  :placement,
  :keep_job_flow_alive_when_no_steps,
  :termination_protected,
  :hadoop_version,
  :ec2_subnet_id,
  :ec2_subnet_ids,
  :emr_managed_master_security_group,
  :emr_managed_slave_security_group,
  :service_access_security_group,
  :additional_master_security_groups,
  :additional_slave_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#instance_count ⇒ Integer

The number of EC2 instances in the cluster.

Returns:

• (Integer)

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

class JobFlowInstancesConfig < Struct.new(
  :master_instance_type,
  :slave_instance_type,
  :instance_count,
  :instance_groups,
  :instance_fleets,
  :ec2_key_name,
  :placement,
  :keep_job_flow_alive_when_no_steps,
  :termination_protected,
  :hadoop_version,
  :ec2_subnet_id,
  :ec2_subnet_ids,
  :emr_managed_master_security_group,
  :emr_managed_slave_security_group,
  :service_access_security_group,
  :additional_master_security_groups,
  :additional_slave_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#instance_fleets ⇒ Array<Types::InstanceFleetConfig>

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration.

Returns:

• (Array<Types::InstanceFleetConfig>)

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

class JobFlowInstancesConfig < Struct.new(
  :master_instance_type,
  :slave_instance_type,
  :instance_count,
  :instance_groups,
  :instance_fleets,
  :ec2_key_name,
  :placement,
  :keep_job_flow_alive_when_no_steps,
  :termination_protected,
  :hadoop_version,
  :ec2_subnet_id,
  :ec2_subnet_ids,
  :emr_managed_master_security_group,
  :emr_managed_slave_security_group,
  :service_access_security_group,
  :additional_master_security_groups,
  :additional_slave_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#instance_groups ⇒ Array<Types::InstanceGroupConfig>

Configuration for the instance groups in a cluster.

Returns:

• (Array<Types::InstanceGroupConfig>)

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

class JobFlowInstancesConfig < Struct.new(
  :master_instance_type,
  :slave_instance_type,
  :instance_count,
  :instance_groups,
  :instance_fleets,
  :ec2_key_name,
  :placement,
  :keep_job_flow_alive_when_no_steps,
  :termination_protected,
  :hadoop_version,
  :ec2_subnet_id,
  :ec2_subnet_ids,
  :emr_managed_master_security_group,
  :emr_managed_slave_security_group,
  :service_access_security_group,
  :additional_master_security_groups,
  :additional_slave_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#keep_job_flow_alive_when_no_steps ⇒ Boolean

Specifies whether the cluster should remain available after completing all steps. Defaults to true. For more information about configuring cluster termination, see Control Cluster Termination in the EMR Management Guide.

Returns:

• (Boolean)

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

class JobFlowInstancesConfig < Struct.new(
  :master_instance_type,
  :slave_instance_type,
  :instance_count,
  :instance_groups,
  :instance_fleets,
  :ec2_key_name,
  :placement,
  :keep_job_flow_alive_when_no_steps,
  :termination_protected,
  :hadoop_version,
  :ec2_subnet_id,
  :ec2_subnet_ids,
  :emr_managed_master_security_group,
  :emr_managed_slave_security_group,
  :service_access_security_group,
  :additional_master_security_groups,
  :additional_slave_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#master_instance_type ⇒ String

The EC2 instance type of the master node.

Returns:

• (String)

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

class JobFlowInstancesConfig < Struct.new(
  :master_instance_type,
  :slave_instance_type,
  :instance_count,
  :instance_groups,
  :instance_fleets,
  :ec2_key_name,
  :placement,
  :keep_job_flow_alive_when_no_steps,
  :termination_protected,
  :hadoop_version,
  :ec2_subnet_id,
  :ec2_subnet_ids,
  :emr_managed_master_security_group,
  :emr_managed_slave_security_group,
  :service_access_security_group,
  :additional_master_security_groups,
  :additional_slave_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#placement ⇒ Types::PlacementType

The Availability Zone in which the cluster runs.

Returns:

• (Types::PlacementType)

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

class JobFlowInstancesConfig < Struct.new(
  :master_instance_type,
  :slave_instance_type,
  :instance_count,
  :instance_groups,
  :instance_fleets,
  :ec2_key_name,
  :placement,
  :keep_job_flow_alive_when_no_steps,
  :termination_protected,
  :hadoop_version,
  :ec2_subnet_id,
  :ec2_subnet_ids,
  :emr_managed_master_security_group,
  :emr_managed_slave_security_group,
  :service_access_security_group,
  :additional_master_security_groups,
  :additional_slave_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#service_access_security_group ⇒ String

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

Returns:

• (String)

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

class JobFlowInstancesConfig < Struct.new(
  :master_instance_type,
  :slave_instance_type,
  :instance_count,
  :instance_groups,
  :instance_fleets,
  :ec2_key_name,
  :placement,
  :keep_job_flow_alive_when_no_steps,
  :termination_protected,
  :hadoop_version,
  :ec2_subnet_id,
  :ec2_subnet_ids,
  :emr_managed_master_security_group,
  :emr_managed_slave_security_group,
  :service_access_security_group,
  :additional_master_security_groups,
  :additional_slave_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#slave_instance_type ⇒ String

The EC2 instance type of the core and task nodes.

Returns:

• (String)

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

class JobFlowInstancesConfig < Struct.new(
  :master_instance_type,
  :slave_instance_type,
  :instance_count,
  :instance_groups,
  :instance_fleets,
  :ec2_key_name,
  :placement,
  :keep_job_flow_alive_when_no_steps,
  :termination_protected,
  :hadoop_version,
  :ec2_subnet_id,
  :ec2_subnet_ids,
  :emr_managed_master_security_group,
  :emr_managed_slave_security_group,
  :service_access_security_group,
  :additional_master_security_groups,
  :additional_slave_security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#termination_protected ⇒ Boolean

Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error.

Returns:

• (Boolean)

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

class JobFlowInstancesConfig < Struct.new(
  :master_instance_type,
  :slave_instance_type,
  :instance_count,
  :instance_groups,
  :instance_fleets,
  :ec2_key_name,
  :placement,
  :keep_job_flow_alive_when_no_steps,
  :termination_protected,
  :hadoop_version,
  :ec2_subnet_id,
  :ec2_subnet_ids,
  :emr_managed_master_security_group,
  :emr_managed_slave_security_group,
  :service_access_security_group,
  :additional_master_security_groups,
  :additional_slave_security_groups)
  SENSITIVE = []
  include Aws::Structure
end