aws_emr_instance_fleet

account_id

Type: STRING

context

Type: STRING
Provider name: Context
Description: Reserved.

id

Type: STRING
Provider name: Id
Description: The unique identifier of the instance fleet.

instance_fleet_type

Type: STRING
Provider name: InstanceFleetType
Description: The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.

instance_type_specifications

Type: UNORDERED_LIST_STRUCT
Provider name: InstanceTypeSpecifications
Description: An array of specifications for the instance types that comprise an instance fleet.

• bid_price
  Type: STRING
  Provider name: BidPrice
  Description: The bid price for each Amazon EC2 Spot Instance type as defined by InstanceType. Expressed in USD.
  
• bid_price_as_percentage_of_on_demand_price
  Type: DOUBLE
  Provider name: BidPriceAsPercentageOfOnDemandPrice
  Description: The bid price, as a percentage of On-Demand price, for each Amazon EC2 Spot Instance as defined by InstanceType. Expressed as a number (for example, 20 specifies 20%).
  
• configurations
  Type: UNORDERED_LIST_STRUCT
  Provider name: Configurations
  Description: A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR.
  
  • classification
    Type: STRING
    Provider name: Classification
    Description: The classification within a configuration.
    
  • configurations
    Type: STRING
    Provider name: Configurations
    Description: A list of additional configurations to apply within a configuration object.
    
  • properties
    Type: MAP_STRING_STRING
    Provider name: Properties
    Description: A set of properties specified within a configuration classification.
    
• custom_ami_id
  Type: STRING
  Provider name: CustomAmiId
  Description: The custom AMI ID to use for the instance type.
  
• ebs_block_devices
  Type: UNORDERED_LIST_STRUCT
  Provider name: EbsBlockDevices
  Description: The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each instance as defined by InstanceType.
  
  • device
    Type: STRING
    Provider name: Device
    Description: The device name that is exposed to the instance, such as /dev/sdh.
    
  • volume_specification
    Type: STRUCT
    Provider name: VolumeSpecification
    Description: EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) that are requested for the EBS volume attached to an Amazon EC2 instance in the cluster.
    
    • iops
      Type: INT32
      Provider name: Iops
      Description: The number of I/O operations per second (IOPS) that the volume supports.
      
    • size_in_gb
      Type: INT32
      Provider name: SizeInGB
      Description: The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.
      
    • throughput
      Type: INT32
      Provider name: Throughput
      Description: The throughput, in mebibyte per second (MiB/s). This optional parameter can be a number from 125 - 1000 and is valid only for gp3 volumes.
      
    • volume_type
      Type: STRING
      Provider name: VolumeType
      Description: The volume type. Volume types supported are gp3, gp2, io1, st1, sc1, and standard.
      
• ebs_optimized
  Type: BOOLEAN
  Provider name: EbsOptimized
  Description: Evaluates to TRUE when the specified InstanceType is EBS-optimized.
  
• instance_type
  Type: STRING
  Provider name: InstanceType
  Description: The Amazon EC2 instance type, for example m3.xlarge.
  
• priority
  Type: DOUBLE
  Provider name: Priority
  Description: The priority at which Amazon EMR launches the Amazon EC2 instances with this instance type. Priority starts at 0, which is the highest priority. Amazon EMR considers the highest priority first.
  
• weighted_capacity
  Type: INT32
  Provider name: WeightedCapacity
  Description: The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. Capacity values represent performance characteristics such as vCPUs, memory, or I/O. If not specified, the default value is 1.
  

launch_specifications

Type: STRUCT
Provider name: LaunchSpecifications
Description: Describes the launch specification for an instance fleet.

• on_demand_specification
  Type: STRUCT
  Provider name: OnDemandSpecification
  Description: The launch specification for On-Demand Instances in the instance fleet, which determines the allocation strategy and capacity reservation options. The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is available in Amazon EMR releases 5.12.1 and later.
  
  • allocation_strategy
    Type: STRING
    Provider name: AllocationStrategy
    Description: Specifies the strategy to use in launching On-Demand instance fleets. Available options are lowest-price and prioritized. lowest-price specifies to launch the instances with the lowest price first, and prioritized specifies that Amazon EMR should launch the instances with the highest priority first. The default is lowest-price.
    
  • capacity_reservation_options
    Type: STRUCT
    Provider name: CapacityReservationOptions
    Description: The launch specification for On-Demand instances in the instance fleet, which determines the allocation strategy.
    
    • capacity_reservation_preference
      Type: STRING
      Provider name: CapacityReservationPreference
      Description: Indicates the instance’s Capacity Reservation preferences. Possible preferences include:
      • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
      • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.
    • capacity_reservation_resource_group_arn
      Type: STRING
      Provider name: CapacityReservationResourceGroupArn
      Description: The ARN of the Capacity Reservation resource group in which to run the instance.
      
    • usage_strategy
      Type: STRING
      Provider name: UsageStrategy
      Description: Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity. If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price). If you do not specify a value, the fleet fulfills the On-Demand capacity according to the chosen On-Demand allocation strategy.
      
• spot_specification
  Type: STRUCT
  Provider name: SpotSpecification
  Description: The launch specification for Spot instances in the fleet, which determines the allocation strategy, defined duration, and provisioning timeout behavior.
  
  • allocation_strategy
    Type: STRING
    Provider name: AllocationStrategy
    Description: Specifies one of the following strategies to launch Spot Instance fleets: capacity-optimized, price-capacity-optimized, lowest-price, or diversified, and capacity-optimized-prioritized. For more information on the provisioning strategies, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide for Linux Instances. When you launch a Spot Instance fleet with the old console, it automatically launches with the capacity-optimized strategy. You can’t change the allocation strategy from the old console.
    
  • block_duration_minutes
    Type: INT32
    Provider name: BlockDurationMinutes
    Description: The defined duration for Spot Instances (also known as Spot blocks) in minutes. When specified, the Spot Instance does not terminate before the defined duration expires, and defined duration pricing for Spot Instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot Instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates. Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022.
    
  • timeout_action
    Type: STRING
    Provider name: TimeoutAction
    Description: The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot Instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot Instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.
    
  • timeout_duration_minutes
    Type: INT32
    Provider name: TimeoutDurationMinutes
    Description: The Spot provisioning timeout period in minutes. If Spot Instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.
    

name

Type: STRING
Provider name: Name
Description: A friendly name for the instance fleet.

provisioned_on_demand_capacity

Type: INT32
Provider name: ProvisionedOnDemandCapacity
Description: The number of On-Demand units that have been provisioned for the instance fleet to fulfill TargetOnDemandCapacity. This provisioned capacity might be less than or greater than TargetOnDemandCapacity.

provisioned_spot_capacity

Type: INT32
Provider name: ProvisionedSpotCapacity
Description: The number of Spot units that have been provisioned for this instance fleet to fulfill TargetSpotCapacity. This provisioned capacity might be less than or greater than TargetSpotCapacity.

resize_specifications

Type: STRUCT
Provider name: ResizeSpecifications
Description: The resize specification for the instance fleet.

• on_demand_resize_specification
  Type: STRUCT
  Provider name: OnDemandResizeSpecification
  Description: The resize specification for On-Demand Instances in the instance fleet, which contains the allocation strategy, capacity reservation options, and the resize timeout period.
  
  • allocation_strategy
    Type: STRING
    Provider name: AllocationStrategy
    Description: Specifies the allocation strategy to use to launch On-Demand instances during a resize. The default is lowest-price.
    
  • capacity_reservation_options
    Type: STRUCT
    Provider name: CapacityReservationOptions
    
    • capacity_reservation_preference
      Type: STRING
      Provider name: CapacityReservationPreference
      Description: Indicates the instance’s Capacity Reservation preferences. Possible preferences include:
      • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
      • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.
    • capacity_reservation_resource_group_arn
      Type: STRING
      Provider name: CapacityReservationResourceGroupArn
      Description: The ARN of the Capacity Reservation resource group in which to run the instance.
      
    • usage_strategy
      Type: STRING
      Provider name: UsageStrategy
      Description: Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity. If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price). If you do not specify a value, the fleet fulfills the On-Demand capacity according to the chosen On-Demand allocation strategy.
      
  • timeout_duration_minutes
    Type: INT32
    Provider name: TimeoutDurationMinutes
    Description: On-Demand resize timeout in minutes. If On-Demand Instances are not provisioned within this time, the resize workflow stops. The minimum value is 5 minutes, and the maximum value is 10,080 minutes (7 days). The timeout applies to all resize workflows on the Instance Fleet. The resize could be triggered by Amazon EMR Managed Scaling or by the customer (via Amazon EMR Console, Amazon EMR CLI modify-instance-fleet or Amazon EMR SDK ModifyInstanceFleet API) or by Amazon EMR due to Amazon EC2 Spot Reclamation.
    
• spot_resize_specification
  Type: STRUCT
  Provider name: SpotResizeSpecification
  Description: The resize specification for Spot Instances in the instance fleet, which contains the allocation strategy and the resize timeout period.
  
  • allocation_strategy
    Type: STRING
    Provider name: AllocationStrategy
    Description: Specifies the allocation strategy to use to launch Spot instances during a resize. If you run Amazon EMR releases 6.9.0 or higher, the default is price-capacity-optimized. If you run Amazon EMR releases 6.8.0 or lower, the default is capacity-optimized.
    
  • timeout_duration_minutes
    Type: INT32
    Provider name: TimeoutDurationMinutes
    Description: Spot resize timeout in minutes. If Spot Instances are not provisioned within this time, the resize workflow will stop provisioning of Spot instances. Minimum value is 5 minutes and maximum value is 10,080 minutes (7 days). The timeout applies to all resize workflows on the Instance Fleet. The resize could be triggered by Amazon EMR Managed Scaling or by the customer (via Amazon EMR Console, Amazon EMR CLI modify-instance-fleet or Amazon EMR SDK ModifyInstanceFleet API) or by Amazon EMR due to Amazon EC2 Spot Reclamation.
    

status

Type: STRUCT
Provider name: Status
Description: The current status of the instance fleet.

• state
  Type: STRING
  Provider name: State
  Description: A code representing the instance fleet status.
  • PROVISIONING—The instance fleet is provisioning Amazon EC2 resources and is not yet ready to run jobs.
  • BOOTSTRAPPING—Amazon EC2 instances and other resources have been provisioned and the bootstrap actions specified for the instances are underway.
  • RUNNING—Amazon EC2 instances and other resources are running. They are either executing jobs or waiting to execute jobs.
  • RESIZING—A resize operation is underway. Amazon EC2 instances are either being added or removed.
  • SUSPENDED—A resize operation could not complete. Existing Amazon EC2 instances are running, but instances can’t be added or removed.
  • TERMINATING—The instance fleet is terminating Amazon EC2 instances.
  • TERMINATED—The instance fleet is no longer active, and all Amazon EC2 instances have been terminated.
• state_change_reason
  Type: STRUCT
  Provider name: StateChangeReason
  Description: Provides status change reason details for the instance fleet.
  
  • code
    Type: STRING
    Provider name: Code
    Description: A code corresponding to the reason the state change occurred.
    
  • message
    Type: STRING
    Provider name: Message
    Description: An explanatory message.
    
• timeline
  Type: STRUCT
  Provider name: Timeline
  Description: Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs, and the time of termination.
  
  • creation_date_time
    Type: TIMESTAMP
    Provider name: CreationDateTime
    Description: The time and date the instance fleet was created.
    
  • end_date_time
    Type: TIMESTAMP
    Provider name: EndDateTime
    Description: The time and date the instance fleet terminated.
    
  • ready_date_time
    Type: TIMESTAMP
    Provider name: ReadyDateTime
    Description: The time and date the instance fleet was ready to run jobs.
    

tags

Type: UNORDERED_LIST_STRING

target_on_demand_capacity

Type: INT32
Provider name: TargetOnDemandCapacity
Description: The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand Instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand Instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity units that have been provisioned for the instance fleet. If not specified or set to 0, only Spot Instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

target_spot_capacity

Type: INT32
Provider name: TargetSpotCapacity
Description: The target capacity of Spot units for the instance fleet, which determines how many Spot Instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units that have been provisioned for the instance fleet. If not specified or set to 0, only On-Demand Instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.