software.amazon.awscdk.services.emr

Class CfnInstanceFleetConfig

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.emr.CfnInstanceFleetConfig

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.209Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnInstanceFleetConfig.Builder A fluent builder for CfnInstanceFleetConfig.
static interface	CfnInstanceFleetConfig.ConfigurationProperty > Used only with Amazon EMR release 4.0 and later.
static interface	CfnInstanceFleetConfig.EbsBlockDeviceConfigProperty `EbsBlockDeviceConfig` is a subproperty of the `EbsConfiguration` property type.
static interface	CfnInstanceFleetConfig.EbsConfigurationProperty `EbsConfiguration` determines the EBS volumes to attach to EMR cluster instances.
static interface	CfnInstanceFleetConfig.InstanceFleetProvisioningSpecificationsProperty > The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.
static interface	CfnInstanceFleetConfig.InstanceTypeConfigProperty `InstanceType` config is a subproperty of `InstanceFleetConfig` .
static interface	CfnInstanceFleetConfig.OnDemandProvisioningSpecificationProperty The launch specification for On-Demand Instances in the instance fleet, which determines the allocation strategy.
static interface	CfnInstanceFleetConfig.SpotProvisioningSpecificationProperty `SpotProvisioningSpecification` is a subproperty of the `InstanceFleetProvisioningSpecifications` property type.
static interface	CfnInstanceFleetConfig.VolumeSpecificationProperty `VolumeSpecification` is a subproperty of the `EbsBlockDeviceConfig` property type.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnInstanceFleetConfig(software.constructs.Construct scope, String id, CfnInstanceFleetConfigProps props) Create a new `AWS::EMR::InstanceFleetConfig`.
protected	CfnInstanceFleetConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnInstanceFleetConfig(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getClusterId() The unique identifier of the EMR cluster.
String	getInstanceFleetType() The node type that the instance fleet hosts.
Object	getInstanceTypeConfigs() `InstanceTypeConfigs` determine the EC2 instances that Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities.
Object	getLaunchSpecifications() The launch specification for the instance fleet.
String	getName() The friendly name of the instance fleet.
Number	getTargetOnDemandCapacity() The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision.
Number	getTargetSpotCapacity() The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setClusterId(String value) The unique identifier of the EMR cluster.
void	setInstanceFleetType(String value) The node type that the instance fleet hosts.
void	setInstanceTypeConfigs(IResolvable value) `InstanceTypeConfigs` determine the EC2 instances that Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities.
void	setInstanceTypeConfigs(List<Object> value) `InstanceTypeConfigs` determine the EC2 instances that Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities.
void	setLaunchSpecifications(CfnInstanceFleetConfig.InstanceFleetProvisioningSpecificationsProperty value) The launch specification for the instance fleet.
void	setLaunchSpecifications(IResolvable value) The launch specification for the instance fleet.
void	setName(String value) The friendly name of the instance fleet.
void	setTargetOnDemandCapacity(Number value) The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision.
void	setTargetSpotCapacity(Number value) The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnInstanceFleetConfig

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

CfnInstanceFleetConfig

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

CfnInstanceFleetConfig

@Stability(value=Stable)
public CfnInstanceFleetConfig(@NotNull
                                                       software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getClusterId

@Stability(value=Stable)
 @NotNull
public String getClusterId()

The unique identifier of the EMR cluster.

setClusterId

@Stability(value=Stable)
public void setClusterId(@NotNull
                                                  String value)

The unique identifier of the EMR cluster.

getInstanceFleetType

@Stability(value=Stable)
 @NotNull
public String getInstanceFleetType()

The node type that the instance fleet hosts.

Allowed Values : TASK

setInstanceFleetType

@Stability(value=Stable)
public void setInstanceFleetType(@NotNull
                                                          String value)

The node type that the instance fleet hosts.

Allowed Values : TASK

getInstanceTypeConfigs

@Stability(value=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(value=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(value=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(value=Stable)
 @Nullable
public Object getLaunchSpecifications()

The launch specification for the instance fleet.

setLaunchSpecifications

@Stability(value=Stable)
public void setLaunchSpecifications(@Nullable
                                                             CfnInstanceFleetConfig.InstanceFleetProvisioningSpecificationsProperty value)

The launch specification for the instance fleet.

setLaunchSpecifications

@Stability(value=Stable)
public void setLaunchSpecifications(@Nullable
                                                             IResolvable value)

The launch specification for the instance fleet.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The friendly name of the instance fleet.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The friendly name of the instance fleet.

getTargetOnDemandCapacity

@Stability(value=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(value=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(value=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(value=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.