Package software.amazon.awscdk.services.emr

Class CfnInstanceFleetConfig

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.emr.CfnInstanceFleetConfig
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.609Z") @Stability(Stable) public class CfnInstanceFleetConfig extends CfnResource implements IInspectable
A CloudFormation 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 .

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. > 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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.emr.*;
 ConfigurationProperty configurationProperty_;
 CfnInstanceFleetConfig cfnInstanceFleetConfig = CfnInstanceFleetConfig.Builder.create(this, "MyCfnInstanceFleetConfig")
         .clusterId("clusterId")
         .instanceFleetType("instanceFleetType")
         // the properties below are optional
         .instanceTypeConfigs(List.of(InstanceTypeConfigProperty.builder()
                 .instanceType("instanceType")
                 // the properties below are optional
                 .bidPrice("bidPrice")
                 .bidPriceAsPercentageOfOnDemandPrice(123)
                 .configurations(List.of(ConfigurationProperty.builder()
                         .classification("classification")
                         .configurationProperties(Map.of(
                                 "configurationPropertiesKey", "configurationProperties"))
                         .configurations(List.of(configurationProperty_))
                         .build()))
                 .customAmiId("customAmiId")
                 .ebsConfiguration(EbsConfigurationProperty.builder()
                         .ebsBlockDeviceConfigs(List.of(EbsBlockDeviceConfigProperty.builder()
                                 .volumeSpecification(VolumeSpecificationProperty.builder()
                                         .sizeInGb(123)
                                         .volumeType("volumeType")
                                         // the properties below are optional
                                         .iops(123)
                                         .build())
                                 // the properties below are optional
                                 .volumesPerInstance(123)
                                 .build()))
                         .ebsOptimized(false)
                         .build())
                 .weightedCapacity(123)
                 .build()))
         .launchSpecifications(InstanceFleetProvisioningSpecificationsProperty.builder()
                 .onDemandSpecification(OnDemandProvisioningSpecificationProperty.builder()
                         .allocationStrategy("allocationStrategy")
                         .build())
                 .spotSpecification(SpotProvisioningSpecificationProperty.builder()
                         .timeoutAction("timeoutAction")
                         .timeoutDurationMinutes(123)
                         // the properties below are optional
                         .allocationStrategy("allocationStrategy")
                         .blockDurationMinutes(123)
                         .build())
                 .build())
         .name("name")
         .targetOnDemandCapacity(123)
         .targetSpotCapacity(123)
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnInstanceFleetConfig

      protected CfnInstanceFleetConfig(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnInstanceFleetConfig

      protected CfnInstanceFleetConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnInstanceFleetConfig

      @Stability(Stable) public CfnInstanceFleetConfig(@NotNull Construct scope, @NotNull String id, @NotNull CfnInstanceFleetConfigProps props)
      Create a new AWS::EMR::InstanceFleetConfig.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getClusterId

      @Stability(Stable) @NotNull public String getClusterId()
      The unique identifier of the EMR cluster.

    • setClusterId

      @Stability(Stable) public void setClusterId(@NotNull String value)
      The unique identifier of the EMR cluster.

    • getInstanceFleetType

      @Stability(Stable) @NotNull public String getInstanceFleetType()
      The node type that the instance fleet hosts.

      Allowed Values : TASK

    • setInstanceFleetType

      @Stability(Stable) public void setInstanceFleetType(@NotNull String value)
      The node type that the instance fleet hosts.

      Allowed Values : TASK

    • getInstanceTypeConfigs

      @Stability(Stable) @Nullable public Object getInstanceTypeConfigs()
      InstanceTypeConfigs determine the EC2 instances that Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities.

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

    • setInstanceTypeConfigs

      @Stability(Stable) public void setInstanceTypeConfigs(@Nullable IResolvable value)
      InstanceTypeConfigs determine the EC2 instances that Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities.

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

    • setInstanceTypeConfigs

      @Stability(Stable) public void setInstanceTypeConfigs(@Nullable List<Object> value)
      InstanceTypeConfigs determine the EC2 instances that Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities.

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

    • getLaunchSpecifications

      @Stability(Stable) @Nullable public Object getLaunchSpecifications()
      The launch specification for the instance fleet.

    • setLaunchSpecifications

      @Stability(Stable) public void setLaunchSpecifications(@Nullable IResolvable value)
      The launch specification for the instance fleet.

    • setLaunchSpecifications

      @Stability(Stable) public void setLaunchSpecifications(@Nullable CfnInstanceFleetConfig.InstanceFleetProvisioningSpecificationsProperty value)
      The launch specification for the instance fleet.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The friendly name of the instance fleet.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The friendly name of the instance fleet.

    • getTargetOnDemandCapacity

      @Stability(Stable) @Nullable public Number getTargetOnDemandCapacity()
      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.

      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.

    • setTargetOnDemandCapacity

      @Stability(Stable) public void setTargetOnDemandCapacity(@Nullable Number value)
      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.

      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.

    • getTargetSpotCapacity

      @Stability(Stable) @Nullable public Number getTargetSpotCapacity()
      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.

      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.

    • setTargetSpotCapacity

      @Stability(Stable) public void setTargetSpotCapacity(@Nullable Number value)
      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.

      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.