Package software.amazon.awscdk.services.ec2

Class CfnEC2Fleet

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.ec2.CfnEC2Fleet

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:28.427Z")
@Stability(Stable)
public class CfnEC2Fleet
extends CfnResource
implements IInspectable

Specifies the configuration information to launch a fleet--or group--of instances.

An EC2 Fleet can launch multiple instance types across multiple Availability Zones, using the On-Demand Instance, Reserved Instance, and Spot Instance purchasing models together. Using EC2 Fleet, you can define separate On-Demand and Spot capacity targets, specify the instance types that work best for your applications, and specify how Amazon EC2 should distribute your fleet capacity within each purchasing model. For more information, see Launching an EC2 Fleet in the Amazon EC2 User Guide for Linux Instances .

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.ec2.*;
 CfnEC2Fleet cfnEC2Fleet = CfnEC2Fleet.Builder.create(this, "MyCfnEC2Fleet")
         .launchTemplateConfigs(List.of(FleetLaunchTemplateConfigRequestProperty.builder()
                 .launchTemplateSpecification(FleetLaunchTemplateSpecificationRequestProperty.builder()
                         .version("version")
                         // the properties below are optional
                         .launchTemplateId("launchTemplateId")
                         .launchTemplateName("launchTemplateName")
                         .build())
                 .overrides(List.of(FleetLaunchTemplateOverridesRequestProperty.builder()
                         .availabilityZone("availabilityZone")
                         .instanceRequirements(InstanceRequirementsRequestProperty.builder()
                                 .acceleratorCount(AcceleratorCountRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .acceleratorManufacturers(List.of("acceleratorManufacturers"))
                                 .acceleratorNames(List.of("acceleratorNames"))
                                 .acceleratorTotalMemoryMiB(AcceleratorTotalMemoryMiBRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .acceleratorTypes(List.of("acceleratorTypes"))
                                 .allowedInstanceTypes(List.of("allowedInstanceTypes"))
                                 .bareMetal("bareMetal")
                                 .baselineEbsBandwidthMbps(BaselineEbsBandwidthMbpsRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .burstablePerformance("burstablePerformance")
                                 .cpuManufacturers(List.of("cpuManufacturers"))
                                 .excludedInstanceTypes(List.of("excludedInstanceTypes"))
                                 .instanceGenerations(List.of("instanceGenerations"))
                                 .localStorage("localStorage")
                                 .localStorageTypes(List.of("localStorageTypes"))
                                 .maxSpotPriceAsPercentageOfOptimalOnDemandPrice(123)
                                 .memoryGiBPerVCpu(MemoryGiBPerVCpuRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .memoryMiB(MemoryMiBRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .networkBandwidthGbps(NetworkBandwidthGbpsRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .networkInterfaceCount(NetworkInterfaceCountRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .onDemandMaxPricePercentageOverLowestPrice(123)
                                 .requireHibernateSupport(false)
                                 .spotMaxPricePercentageOverLowestPrice(123)
                                 .totalLocalStorageGb(TotalLocalStorageGBRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .vCpuCount(VCpuCountRangeRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .build())
                         .instanceType("instanceType")
                         .maxPrice("maxPrice")
                         .placement(PlacementProperty.builder()
                                 .affinity("affinity")
                                 .availabilityZone("availabilityZone")
                                 .groupName("groupName")
                                 .hostId("hostId")
                                 .hostResourceGroupArn("hostResourceGroupArn")
                                 .partitionNumber(123)
                                 .spreadDomain("spreadDomain")
                                 .tenancy("tenancy")
                                 .build())
                         .priority(123)
                         .subnetId("subnetId")
                         .weightedCapacity(123)
                         .build()))
                 .build()))
         .targetCapacitySpecification(TargetCapacitySpecificationRequestProperty.builder()
                 .totalTargetCapacity(123)
                 // the properties below are optional
                 .defaultTargetCapacityType("defaultTargetCapacityType")
                 .onDemandTargetCapacity(123)
                 .spotTargetCapacity(123)
                 .targetCapacityUnitType("targetCapacityUnitType")
                 .build())
         // the properties below are optional
         .context("context")
         .excessCapacityTerminationPolicy("excessCapacityTerminationPolicy")
         .onDemandOptions(OnDemandOptionsRequestProperty.builder()
                 .allocationStrategy("allocationStrategy")
                 .capacityReservationOptions(CapacityReservationOptionsRequestProperty.builder()
                         .usageStrategy("usageStrategy")
                         .build())
                 .maxTotalPrice("maxTotalPrice")
                 .minTargetCapacity(123)
                 .singleAvailabilityZone(false)
                 .singleInstanceType(false)
                 .build())
         .replaceUnhealthyInstances(false)
         .spotOptions(SpotOptionsRequestProperty.builder()
                 .allocationStrategy("allocationStrategy")
                 .instanceInterruptionBehavior("instanceInterruptionBehavior")
                 .instancePoolsToUseCount(123)
                 .maintenanceStrategies(MaintenanceStrategiesProperty.builder()
                         .capacityRebalance(CapacityRebalanceProperty.builder()
                                 .replacementStrategy("replacementStrategy")
                                 .terminationDelay(123)
                                 .build())
                         .build())
                 .maxTotalPrice("maxTotalPrice")
                 .minTargetCapacity(123)
                 .singleAvailabilityZone(false)
                 .singleInstanceType(false)
                 .build())
         .tagSpecifications(List.of(TagSpecificationProperty.builder()
                 .resourceType("resourceType")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build()))
         .terminateInstancesWithExpiration(false)
         .type("type")
         .validFrom("validFrom")
         .validUntil("validUntil")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ec2fleet.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnEC2Fleet.AcceleratorCountRequestProperty	The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.
static interface	CfnEC2Fleet.AcceleratorTotalMemoryMiBRequestProperty	The minimum and maximum amount of total accelerator memory, in MiB.
static interface	CfnEC2Fleet.BaselineEbsBandwidthMbpsRequestProperty	The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps.
static final class	CfnEC2Fleet.Builder	A fluent builder for CfnEC2Fleet.
static interface	CfnEC2Fleet.CapacityRebalanceProperty	The Spot Instance replacement strategy to use when Amazon EC2 emits a rebalance notification signal that your Spot Instance is at an elevated risk of being interrupted.
static interface	CfnEC2Fleet.CapacityReservationOptionsRequestProperty	Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
static interface	CfnEC2Fleet.FleetLaunchTemplateConfigRequestProperty	Specifies a launch template and overrides for an EC2 Fleet.
static interface	CfnEC2Fleet.FleetLaunchTemplateOverridesRequestProperty	Specifies overrides for a launch template for an EC2 Fleet.
static interface	CfnEC2Fleet.FleetLaunchTemplateSpecificationRequestProperty	Specifies the launch template to be used by the EC2 Fleet for configuring Amazon EC2 instances.
static interface	CfnEC2Fleet.InstanceRequirementsRequestProperty	The attributes for the instance types.
static interface	CfnEC2Fleet.MaintenanceStrategiesProperty	The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
static interface	CfnEC2Fleet.MemoryGiBPerVCpuRequestProperty	The minimum and maximum amount of memory per vCPU, in GiB.
static interface	CfnEC2Fleet.MemoryMiBRequestProperty	The minimum and maximum amount of memory, in MiB.
static interface	CfnEC2Fleet.NetworkBandwidthGbpsRequestProperty	The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
static interface	CfnEC2Fleet.NetworkInterfaceCountRequestProperty	The minimum and maximum number of network interfaces.
static interface	CfnEC2Fleet.OnDemandOptionsRequestProperty	Specifies the allocation strategy of On-Demand Instances in an EC2 Fleet.
static interface	CfnEC2Fleet.PlacementProperty	Describes the placement of an instance.
static interface	CfnEC2Fleet.SpotOptionsRequestProperty	Specifies the configuration of Spot Instances for an EC2 Fleet.
static interface	CfnEC2Fleet.TagSpecificationProperty	Specifies the tags to apply to a resource when the resource is being created for an EC2 Fleet.
static interface	CfnEC2Fleet.TargetCapacitySpecificationRequestProperty	Specifies the number of units to request for an EC2 Fleet.
static interface	CfnEC2Fleet.TotalLocalStorageGBRequestProperty	The minimum and maximum amount of total local storage, in GB.
static interface	CfnEC2Fleet.VCpuCountRangeRequestProperty	The minimum and maximum number of vCPUs.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnEC2Fleet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEC2Fleet(software.amazon.jsii.JsiiObjectRef objRef)
	CfnEC2Fleet(software.constructs.Construct scope, String id, CfnEC2FleetProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrFleetId()	The ID of the EC2 Fleet.
protected Map<String,Object>	getCfnProperties()
String	getContext()	Reserved.
String	getExcessCapacityTerminationPolicy()	Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
Object	getLaunchTemplateConfigs()	The configuration for the EC2 Fleet.
Object	getOnDemandOptions()	Describes the configuration of On-Demand Instances in an EC2 Fleet.
Object	getReplaceUnhealthyInstances()	Indicates whether EC2 Fleet should replace unhealthy Spot Instances.
Object	getSpotOptions()	Describes the configuration of Spot Instances in an EC2 Fleet.
Object	getTagSpecifications()	The key-value pair for tagging the EC2 Fleet request on creation.
Object	getTargetCapacitySpecification()	The number of units to request.
Object	getTerminateInstancesWithExpiration()	Indicates whether running instances should be terminated when the EC2 Fleet expires.
String	getType()	The fleet type.
String	getValidFrom()	The start date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).
String	getValidUntil()	The end date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setContext(String value)	Reserved.
void	setExcessCapacityTerminationPolicy(String value)	Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
void	setLaunchTemplateConfigs(List<Object> value)	The configuration for the EC2 Fleet.
void	setLaunchTemplateConfigs(IResolvable value)	The configuration for the EC2 Fleet.
void	setOnDemandOptions(IResolvable value)	Describes the configuration of On-Demand Instances in an EC2 Fleet.
void	setOnDemandOptions(CfnEC2Fleet.OnDemandOptionsRequestProperty value)	Describes the configuration of On-Demand Instances in an EC2 Fleet.
void	setReplaceUnhealthyInstances(Boolean value)	Indicates whether EC2 Fleet should replace unhealthy Spot Instances.
void	setReplaceUnhealthyInstances(IResolvable value)	Indicates whether EC2 Fleet should replace unhealthy Spot Instances.
void	setSpotOptions(IResolvable value)	Describes the configuration of Spot Instances in an EC2 Fleet.
void	setSpotOptions(CfnEC2Fleet.SpotOptionsRequestProperty value)	Describes the configuration of Spot Instances in an EC2 Fleet.
void	setTagSpecifications(List<Object> value)	The key-value pair for tagging the EC2 Fleet request on creation.
void	setTagSpecifications(IResolvable value)	The key-value pair for tagging the EC2 Fleet request on creation.
void	setTargetCapacitySpecification(IResolvable value)	The number of units to request.
void	setTargetCapacitySpecification(CfnEC2Fleet.TargetCapacitySpecificationRequestProperty value)	The number of units to request.
void	setTerminateInstancesWithExpiration(Boolean value)	Indicates whether running instances should be terminated when the EC2 Fleet expires.
void	setTerminateInstancesWithExpiration(IResolvable value)	Indicates whether running instances should be terminated when the EC2 Fleet expires.
void	setType(String value)	The fleet type.
void	setValidFrom(String value)	The start date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).
void	setValidUntil(String value)	The end date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 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

CfnEC2Fleet

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

CfnEC2Fleet

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

CfnEC2Fleet

@Stability(Stable)
public CfnEC2Fleet(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnEC2FleetProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). 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.

getAttrFleetId

@Stability(Stable)
@NotNull
public String getAttrFleetId()

The ID of the EC2 Fleet.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getLaunchTemplateConfigs

@Stability(Stable)
@NotNull
public Object getLaunchTemplateConfigs()

The configuration for the EC2 Fleet.

setLaunchTemplateConfigs

@Stability(Stable)
public void setLaunchTemplateConfigs(@NotNull
 IResolvable value)

The configuration for the EC2 Fleet.

setLaunchTemplateConfigs

@Stability(Stable)
public void setLaunchTemplateConfigs(@NotNull
 List<Object> value)

The configuration for the EC2 Fleet.

getTargetCapacitySpecification

@Stability(Stable)
@NotNull
public Object getTargetCapacitySpecification()

The number of units to request.

setTargetCapacitySpecification

@Stability(Stable)
public void setTargetCapacitySpecification(@NotNull
 IResolvable value)

The number of units to request.

setTargetCapacitySpecification

@Stability(Stable)
public void setTargetCapacitySpecification(@NotNull
 CfnEC2Fleet.TargetCapacitySpecificationRequestProperty value)

The number of units to request.

getContext

@Stability(Stable)
@Nullable
public String getContext()

Reserved.

setContext

@Stability(Stable)
public void setContext(@Nullable
 String value)

Reserved.

getExcessCapacityTerminationPolicy

@Stability(Stable)
@Nullable
public String getExcessCapacityTerminationPolicy()

Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

setExcessCapacityTerminationPolicy

@Stability(Stable)
public void setExcessCapacityTerminationPolicy(@Nullable
 String value)

Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

getOnDemandOptions

@Stability(Stable)
@Nullable
public Object getOnDemandOptions()

Describes the configuration of On-Demand Instances in an EC2 Fleet.

setOnDemandOptions

@Stability(Stable)
public void setOnDemandOptions(@Nullable
 IResolvable value)

Describes the configuration of On-Demand Instances in an EC2 Fleet.

setOnDemandOptions

@Stability(Stable)
public void setOnDemandOptions(@Nullable
 CfnEC2Fleet.OnDemandOptionsRequestProperty value)

Describes the configuration of On-Demand Instances in an EC2 Fleet.

getReplaceUnhealthyInstances

@Stability(Stable)
@Nullable
public Object getReplaceUnhealthyInstances()

Indicates whether EC2 Fleet should replace unhealthy Spot Instances.

setReplaceUnhealthyInstances

@Stability(Stable)
public void setReplaceUnhealthyInstances(@Nullable
 Boolean value)

Indicates whether EC2 Fleet should replace unhealthy Spot Instances.

setReplaceUnhealthyInstances

@Stability(Stable)
public void setReplaceUnhealthyInstances(@Nullable
 IResolvable value)

Indicates whether EC2 Fleet should replace unhealthy Spot Instances.

getSpotOptions

@Stability(Stable)
@Nullable
public Object getSpotOptions()

Describes the configuration of Spot Instances in an EC2 Fleet.

setSpotOptions

@Stability(Stable)
public void setSpotOptions(@Nullable
 IResolvable value)

Describes the configuration of Spot Instances in an EC2 Fleet.

setSpotOptions

@Stability(Stable)
public void setSpotOptions(@Nullable
 CfnEC2Fleet.SpotOptionsRequestProperty value)

Describes the configuration of Spot Instances in an EC2 Fleet.

getTagSpecifications

@Stability(Stable)
@Nullable
public Object getTagSpecifications()

The key-value pair for tagging the EC2 Fleet request on creation.

For more information, see Tag your resources .

setTagSpecifications

@Stability(Stable)
public void setTagSpecifications(@Nullable
 IResolvable value)

The key-value pair for tagging the EC2 Fleet request on creation.

For more information, see Tag your resources .

setTagSpecifications

@Stability(Stable)
public void setTagSpecifications(@Nullable
 List<Object> value)

The key-value pair for tagging the EC2 Fleet request on creation.

For more information, see Tag your resources .

getTerminateInstancesWithExpiration

@Stability(Stable)
@Nullable
public Object getTerminateInstancesWithExpiration()

Indicates whether running instances should be terminated when the EC2 Fleet expires.

setTerminateInstancesWithExpiration

@Stability(Stable)
public void setTerminateInstancesWithExpiration(@Nullable
 Boolean value)

Indicates whether running instances should be terminated when the EC2 Fleet expires.

setTerminateInstancesWithExpiration

@Stability(Stable)
public void setTerminateInstancesWithExpiration(@Nullable
 IResolvable value)

Indicates whether running instances should be terminated when the EC2 Fleet expires.

getType

@Stability(Stable)
@Nullable
public String getType()

The fleet type.

The default value is maintain .

setType

@Stability(Stable)
public void setType(@Nullable
 String value)

The fleet type.

The default value is maintain .

getValidFrom

@Stability(Stable)
@Nullable
public String getValidFrom()

The start date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).

setValidFrom

@Stability(Stable)
public void setValidFrom(@Nullable
 String value)

The start date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).

getValidUntil

@Stability(Stable)
@Nullable
public String getValidUntil()

The end date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).

setValidUntil

@Stability(Stable)
public void setValidUntil(@Nullable
 String value)

The end date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).