AWS::EMR::InstanceFleetConfig - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::EMR::InstanceFleetConfig

Use InstanceFleetConfig to define instance fleets for an EMR cluster. A cluster can not use both instance fleets and instance groups. For more information, see Configure Instance Fleets in the Amazon EMR Management Guide.

Note

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

Important

You can currently only add a task instance fleet to a cluster with this resource. If you use this resource, CloudFormation waits for the cluster launch to complete before adding the task instance fleet to the cluster. In order to add a task instance fleet to the cluster as part of the cluster launch and minimize delays in provisioning task nodes, use the TaskInstanceFleets subproperty for the AWS::EMR::Cluster JobFlowInstancesConfig property instead. To use this subproperty, see AWS::EMR::Cluster for examples.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::EMR::InstanceFleetConfig",
  "Properties" : {
      "ClusterId" : String,
      "InstanceFleetType" : String,
      "InstanceTypeConfigs" : [ InstanceTypeConfig, ... ],
      "LaunchSpecifications" : InstanceFleetProvisioningSpecifications,
      "Name" : String,
      "ResizeSpecifications" : InstanceFleetResizingSpecifications,
      "TargetOnDemandCapacity" : Integer,
      "TargetSpotCapacity" : Integer
    }
}

Properties

ClusterId

The unique identifier of the EMR cluster.

Required: Yes

Type: String

Update requires: Replacement

InstanceFleetType

The node type that the instance fleet hosts.

Allowed Values: TASK

Required: Yes

Type: String

Update requires: Replacement

InstanceTypeConfigs

InstanceTypeConfigs determine the EC2 instances that Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities.

Note

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

Required: No

Type: Array of InstanceTypeConfig

Update requires: No interruption

LaunchSpecifications

The launch specification for the instance fleet.

Required: No

Type: InstanceFleetProvisioningSpecifications

Update requires: Replacement

Name

The friendly name of the instance fleet.

Required: No

Type: String

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Minimum: 0

Maximum: 256

Update requires: Replacement

ResizeSpecifications

The resize specification for the instance fleet.

Required: No

Type: InstanceFleetResizingSpecifications

Update requires: No interruption

TargetOnDemandCapacity

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.

Note

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.

Required: No

Type: Integer

Minimum: 0

Update requires: No interruption

TargetSpotCapacity

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.

Note

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.

Required: No

Type: Integer

Minimum: 0

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns returns the ID of the instance fleet.

For more information about using the Ref function, see Ref.

Fn::GetAtt