Skip to content

InstanceGroup

Source code in docs_src/capo_emr/types/instance_group.py
class InstanceGroup(TypedDict, closed=True):
    id: NotRequired["capo_emr.types.instance_group_id.InstanceGroupId"]
    """<p>The identifier of the instance group.</p>"""
    name: NotRequired["capo_emr.types.string.String"]
    """<p>The name of the instance group.</p>"""
    market: NotRequired["capo_emr.types.market_type.MarketType"]
    """<p>The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.</p>"""
    instance_group_type: NotRequired[
        "capo_emr.types.instance_group_type.InstanceGroupType"
    ]
    """<p>The type of the instance group. Valid values are MASTER, CORE or TASK.</p>"""
    bid_price: NotRequired["capo_emr.types.string.String"]
    """<p>The bid price for each Amazon EC2 Spot Instance type as defined by <code>InstanceType</code>. Expressed in USD. If neither <code>BidPrice</code> nor <code>BidPriceAsPercentageOfOnDemandPrice</code> is provided, <code>BidPriceAsPercentageOfOnDemandPrice</code> defaults to 100%.</p>"""
    instance_type: NotRequired["capo_emr.types.instance_type.InstanceType"]
    """<p>The Amazon EC2 instance type for all instances in the instance group.</p>"""
    requested_instance_count: NotRequired["capo_emr.types.integer.Integer"]
    """<p>The target number of instances for the instance group.</p>"""
    running_instance_count: NotRequired["capo_emr.types.integer.Integer"]
    """<p>The number of instances currently running in this instance group.</p>"""
    status: NotRequired["capo_emr.types.instance_group_status.InstanceGroupStatus"]
    """<p>The current status of the instance group.</p>"""
    configurations: NotRequired["capo_emr.types.configuration_list.ConfigurationList"]
    """<note> <p>Amazon EMR releases 4.x or later.</p> </note> <p>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).</p>"""
    configurations_version: NotRequired["capo_emr.types.long.Long"]
    """<p>The version number of the requested configuration specification for this instance group.</p>"""
    last_successfully_applied_configurations: NotRequired[
        "capo_emr.types.configuration_list.ConfigurationList"
    ]
    """<p>A list of configurations that were successfully applied for an instance group last time.</p>"""
    last_successfully_applied_configurations_version: NotRequired[
        "capo_emr.types.long.Long"
    ]
    """<p>The version number of a configuration specification that was successfully applied for an instance group last time. </p>"""
    ebs_block_devices: NotRequired[
        "capo_emr.types.ebs_block_device_list.EbsBlockDeviceList"
    ]
    """<p>The EBS block devices that are mapped to this instance group.</p>"""
    ebs_optimized: NotRequired["capo_emr.types.boolean_object.BooleanObject"]
    """<p>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.</p>"""
    shrink_policy: NotRequired["capo_emr.types.shrink_policy.ShrinkPolicy"]
    """<p>Policy for customizing shrink operations.</p>"""
    auto_scaling_policy: NotRequired[
        "capo_emr.types.auto_scaling_policy_description.AutoScalingPolicyDescription"
    ]
    """<p>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.</p>"""
    custom_ami_id: NotRequired[
        "capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"
    ]
    """<p>The custom AMI ID to use for the provisioned instance group.</p>"""

auto_scaling_policy instance-attribute

auto_scaling_policy: NotRequired[AutoScalingPolicyDescription]

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.

bid_price instance-attribute

bid_price: NotRequired[String]

The bid price for each Amazon EC2 Spot Instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.

configurations instance-attribute

configurations: NotRequired[ConfigurationList]

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

configurations_version instance-attribute

configurations_version: NotRequired[Long]

The version number of the requested configuration specification for this instance group.

custom_ami_id instance-attribute

custom_ami_id: NotRequired[XmlStringMaxLen256]

The custom AMI ID to use for the provisioned instance group.

ebs_block_devices instance-attribute

ebs_block_devices: NotRequired[EbsBlockDeviceList]

The EBS block devices that are mapped to this instance group.

ebs_optimized instance-attribute

ebs_optimized: NotRequired[BooleanObject]

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.

id instance-attribute

id: NotRequired[InstanceGroupId]

The identifier of the instance group.

instance_group_type instance-attribute

instance_group_type: NotRequired[InstanceGroupType]

The type of the instance group. Valid values are MASTER, CORE or TASK.

instance_type instance-attribute

instance_type: NotRequired[InstanceType]

The Amazon EC2 instance type for all instances in the instance group.

last_successfully_applied_configurations instance-attribute

last_successfully_applied_configurations: NotRequired[ConfigurationList]

A list of configurations that were successfully applied for an instance group last time.

last_successfully_applied_configurations_version instance-attribute

last_successfully_applied_configurations_version: NotRequired[Long]

The version number of a configuration specification that was successfully applied for an instance group last time.

market instance-attribute

market: NotRequired[MarketType]

The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

name instance-attribute

name: NotRequired[String]

The name of the instance group.

requested_instance_count instance-attribute

requested_instance_count: NotRequired[Integer]

The target number of instances for the instance group.

running_instance_count instance-attribute

running_instance_count: NotRequired[Integer]

The number of instances currently running in this instance group.

shrink_policy instance-attribute

shrink_policy: NotRequired[ShrinkPolicy]

Policy for customizing shrink operations.

status instance-attribute

status: NotRequired[InstanceGroupStatus]

The current status of the instance group.