InstanceGroup
This entity represents an instance group, which is a group of instances that have common purpose. For example, CORE instance group is used for HDFS.
Contents
- AutoScalingPolicy
-
An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.
Type: AutoScalingPolicyDescription object
Required: No
- BidPrice
-
If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify
OnDemandPrice
to set the amount equal to the On-Demand price, or specify an amount in USD.Type: String
Required: No
- Configurations
-
Note
Amazon EMR releases 4.x or later.
The list of configurations supplied for an Amazon EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).
Type: Array of Configuration objects
Required: No
- ConfigurationsVersion
-
The version number of the requested configuration specification for this instance group.
Type: Long
Required: No
- CustomAmiId
-
The custom AMI ID to use for the provisioned instance group.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- EbsBlockDevices
-
The EBS block devices that are mapped to this instance group.
Type: Array of EbsBlockDevice objects
Required: No
- EbsOptimized
-
If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.
Type: Boolean
Required: No
- Id
-
The identifier of the instance group.
Type: String
Required: No
- InstanceGroupType
-
The type of the instance group. Valid values are MASTER, CORE or TASK.
Type: String
Valid Values:
MASTER | CORE | TASK
Required: No
- InstanceType
-
The Amazon EC2 instance type for all instances in the instance group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- LastSuccessfullyAppliedConfigurations
-
A list of configurations that were successfully applied for an instance group last time.
Type: Array of Configuration objects
Required: No
- LastSuccessfullyAppliedConfigurationsVersion
-
The version number of a configuration specification that was successfully applied for an instance group last time.
Type: Long
Required: No
- Market
-
The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
Type: String
Valid Values:
ON_DEMAND | SPOT
Required: No
- Name
-
The name of the instance group.
Type: String
Required: No
- RequestedInstanceCount
-
The target number of instances for the instance group.
Type: Integer
Required: No
- RunningInstanceCount
-
The number of instances currently running in this instance group.
Type: Integer
Required: No
- ShrinkPolicy
-
Policy for customizing shrink operations.
Type: ShrinkPolicy object
Required: No
- Status
-
The current status of the instance group.
Type: InstanceGroupStatus object
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: