Interface CfnSpotFleet.ISpotFleetRequestConfigDataProperty
Specifies the configuration of a Spot Fleet request.
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnSpotFleet.ISpotFleetRequestConfigDataPropertySyntax (vb)
Public Interface CfnSpotFleet.ISpotFleetRequestConfigDataPropertyRemarks
For more information, see Spot Fleet in the Amazon EC2 User Guide .
You must specify either LaunchSpecifications or LaunchTemplateConfigs .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
var spotFleetRequestConfigDataProperty = new SpotFleetRequestConfigDataProperty {
IamFleetRole = "iamFleetRole",
TargetCapacity = 123,
// the properties below are optional
AllocationStrategy = "allocationStrategy",
Context = "context",
ExcessCapacityTerminationPolicy = "excessCapacityTerminationPolicy",
InstanceInterruptionBehavior = "instanceInterruptionBehavior",
InstancePoolsToUseCount = 123,
LaunchSpecifications = new [] { new SpotFleetLaunchSpecificationProperty {
ImageId = "imageId",
// the properties below are optional
BlockDeviceMappings = new [] { new BlockDeviceMappingProperty {
DeviceName = "deviceName",
// the properties below are optional
Ebs = new EbsBlockDeviceProperty {
DeleteOnTermination = false,
Encrypted = false,
Iops = 123,
SnapshotId = "snapshotId",
VolumeSize = 123,
VolumeType = "volumeType"
},
NoDevice = "noDevice",
VirtualName = "virtualName"
} },
EbsOptimized = false,
IamInstanceProfile = new IamInstanceProfileSpecificationProperty {
Arn = "arn"
},
InstanceRequirements = new InstanceRequirementsRequestProperty {
AcceleratorCount = new AcceleratorCountRequestProperty {
Max = 123,
Min = 123
},
AcceleratorManufacturers = new [] { "acceleratorManufacturers" },
AcceleratorNames = new [] { "acceleratorNames" },
AcceleratorTotalMemoryMiB = new AcceleratorTotalMemoryMiBRequestProperty {
Max = 123,
Min = 123
},
AcceleratorTypes = new [] { "acceleratorTypes" },
AllowedInstanceTypes = new [] { "allowedInstanceTypes" },
BareMetal = "bareMetal",
BaselineEbsBandwidthMbps = new BaselineEbsBandwidthMbpsRequestProperty {
Max = 123,
Min = 123
},
BaselinePerformanceFactors = new BaselinePerformanceFactorsRequestProperty {
Cpu = new CpuPerformanceFactorRequestProperty {
References = new [] { new PerformanceFactorReferenceRequestProperty {
InstanceFamily = "instanceFamily"
} }
}
},
BurstablePerformance = "burstablePerformance",
CpuManufacturers = new [] { "cpuManufacturers" },
ExcludedInstanceTypes = new [] { "excludedInstanceTypes" },
InstanceGenerations = new [] { "instanceGenerations" },
LocalStorage = "localStorage",
LocalStorageTypes = new [] { "localStorageTypes" },
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice = 123,
MemoryGiBPerVCpu = new MemoryGiBPerVCpuRequestProperty {
Max = 123,
Min = 123
},
MemoryMiB = new MemoryMiBRequestProperty {
Max = 123,
Min = 123
},
NetworkBandwidthGbps = new NetworkBandwidthGbpsRequestProperty {
Max = 123,
Min = 123
},
NetworkInterfaceCount = new NetworkInterfaceCountRequestProperty {
Max = 123,
Min = 123
},
OnDemandMaxPricePercentageOverLowestPrice = 123,
RequireHibernateSupport = false,
SpotMaxPricePercentageOverLowestPrice = 123,
TotalLocalStorageGb = new TotalLocalStorageGBRequestProperty {
Max = 123,
Min = 123
},
VCpuCount = new VCpuCountRangeRequestProperty {
Max = 123,
Min = 123
}
},
InstanceType = "instanceType",
KernelId = "kernelId",
KeyName = "keyName",
Monitoring = new SpotFleetMonitoringProperty {
Enabled = false
},
NetworkInterfaces = new [] { new InstanceNetworkInterfaceSpecificationProperty {
AssociatePublicIpAddress = false,
DeleteOnTermination = false,
Description = "description",
DeviceIndex = 123,
Groups = new [] { "groups" },
Ipv6AddressCount = 123,
Ipv6Addresses = new [] { new InstanceIpv6AddressProperty {
Ipv6Address = "ipv6Address"
} },
NetworkInterfaceId = "networkInterfaceId",
PrivateIpAddresses = new [] { new PrivateIpAddressSpecificationProperty {
PrivateIpAddress = "privateIpAddress",
// the properties below are optional
Primary = false
} },
SecondaryPrivateIpAddressCount = 123,
SubnetId = "subnetId"
} },
Placement = new SpotPlacementProperty {
AvailabilityZone = "availabilityZone",
GroupName = "groupName",
Tenancy = "tenancy"
},
RamdiskId = "ramdiskId",
SecurityGroups = new [] { new GroupIdentifierProperty {
GroupId = "groupId"
} },
SpotPrice = "spotPrice",
SubnetId = "subnetId",
TagSpecifications = new [] { new SpotFleetTagSpecificationProperty {
ResourceType = "resourceType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
} },
UserData = "userData",
WeightedCapacity = 123
} },
LaunchTemplateConfigs = new [] { new LaunchTemplateConfigProperty {
LaunchTemplateSpecification = new FleetLaunchTemplateSpecificationProperty {
Version = "version",
// the properties below are optional
LaunchTemplateId = "launchTemplateId",
LaunchTemplateName = "launchTemplateName"
},
Overrides = new [] { new LaunchTemplateOverridesProperty {
AvailabilityZone = "availabilityZone",
InstanceRequirements = new InstanceRequirementsRequestProperty {
AcceleratorCount = new AcceleratorCountRequestProperty {
Max = 123,
Min = 123
},
AcceleratorManufacturers = new [] { "acceleratorManufacturers" },
AcceleratorNames = new [] { "acceleratorNames" },
AcceleratorTotalMemoryMiB = new AcceleratorTotalMemoryMiBRequestProperty {
Max = 123,
Min = 123
},
AcceleratorTypes = new [] { "acceleratorTypes" },
AllowedInstanceTypes = new [] { "allowedInstanceTypes" },
BareMetal = "bareMetal",
BaselineEbsBandwidthMbps = new BaselineEbsBandwidthMbpsRequestProperty {
Max = 123,
Min = 123
},
BaselinePerformanceFactors = new BaselinePerformanceFactorsRequestProperty {
Cpu = new CpuPerformanceFactorRequestProperty {
References = new [] { new PerformanceFactorReferenceRequestProperty {
InstanceFamily = "instanceFamily"
} }
}
},
BurstablePerformance = "burstablePerformance",
CpuManufacturers = new [] { "cpuManufacturers" },
ExcludedInstanceTypes = new [] { "excludedInstanceTypes" },
InstanceGenerations = new [] { "instanceGenerations" },
LocalStorage = "localStorage",
LocalStorageTypes = new [] { "localStorageTypes" },
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice = 123,
MemoryGiBPerVCpu = new MemoryGiBPerVCpuRequestProperty {
Max = 123,
Min = 123
},
MemoryMiB = new MemoryMiBRequestProperty {
Max = 123,
Min = 123
},
NetworkBandwidthGbps = new NetworkBandwidthGbpsRequestProperty {
Max = 123,
Min = 123
},
NetworkInterfaceCount = new NetworkInterfaceCountRequestProperty {
Max = 123,
Min = 123
},
OnDemandMaxPricePercentageOverLowestPrice = 123,
RequireHibernateSupport = false,
SpotMaxPricePercentageOverLowestPrice = 123,
TotalLocalStorageGb = new TotalLocalStorageGBRequestProperty {
Max = 123,
Min = 123
},
VCpuCount = new VCpuCountRangeRequestProperty {
Max = 123,
Min = 123
}
},
InstanceType = "instanceType",
Priority = 123,
SpotPrice = "spotPrice",
SubnetId = "subnetId",
WeightedCapacity = 123
} }
} },
LoadBalancersConfig = new LoadBalancersConfigProperty {
ClassicLoadBalancersConfig = new ClassicLoadBalancersConfigProperty {
ClassicLoadBalancers = new [] { new ClassicLoadBalancerProperty {
Name = "name"
} }
},
TargetGroupsConfig = new TargetGroupsConfigProperty {
TargetGroups = new [] { new TargetGroupProperty {
Arn = "arn"
} }
}
},
OnDemandAllocationStrategy = "onDemandAllocationStrategy",
OnDemandMaxTotalPrice = "onDemandMaxTotalPrice",
OnDemandTargetCapacity = 123,
ReplaceUnhealthyInstances = false,
SpotMaintenanceStrategies = new SpotMaintenanceStrategiesProperty {
CapacityRebalance = new SpotCapacityRebalanceProperty {
ReplacementStrategy = "replacementStrategy",
TerminationDelay = 123
}
},
SpotMaxTotalPrice = "spotMaxTotalPrice",
SpotPrice = "spotPrice",
TagSpecifications = new [] { new SpotFleetTagSpecificationProperty {
ResourceType = "resourceType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
} },
TargetCapacityUnitType = "targetCapacityUnitType",
TerminateInstancesWithExpiration = false,
Type = "type",
ValidFrom = "validFrom",
ValidUntil = "validUntil"
};Synopsis
Properties
| AllocationStrategy | The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration. |
| Context | Reserved. |
| ExcessCapacityTerminationPolicy | Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet. |
| IamFleetRole | The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. |
| InstanceInterruptionBehavior | The behavior when a Spot Instance is interrupted. |
| InstancePoolsToUseCount | The number of Spot pools across which to allocate your target Spot capacity. |
| LaunchSpecifications | The launch specifications for the Spot Fleet request. |
| LaunchTemplateConfigs | The launch template and overrides. |
| LoadBalancersConfig | One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. |
| OnDemandAllocationStrategy | The order of the launch template overrides to use in fulfilling On-Demand capacity. |
| OnDemandMaxTotalPrice | The maximum amount per hour for On-Demand Instances that you're willing to pay. |
| OnDemandTargetCapacity | The number of On-Demand units to request. |
| ReplaceUnhealthyInstances | Indicates whether Spot Fleet should replace unhealthy instances. |
| SpotMaintenanceStrategies | The strategies for managing your Spot Instances that are at an elevated risk of being interrupted. |
| SpotMaxTotalPrice | The maximum amount per hour for Spot Instances that you're willing to pay. |
| SpotPrice | The maximum price per unit hour that you are willing to pay for a Spot Instance. |
| TagSpecifications | The key-value pair for tagging the Spot Fleet request on creation. |
| TargetCapacity | The number of units to request for the Spot Fleet. |
| TargetCapacityUnitType | The unit for the target capacity. You can specify this parameter only when using attribute-based instance type selection. |
| TerminateInstancesWithExpiration | Indicates whether running Spot Instances are terminated when the Spot Fleet request expires. |
| Type | The type of request. |
| ValidFrom | The start date and time of the request, in UTC format ( YYYY - MM - DD T HH : MM : SS Z). |
| ValidUntil | The end date and time of the request, in UTC format ( YYYY - MM - DD T HH : MM : SS Z). |
Properties
AllocationStrategy
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration.
string? AllocationStrategy { get; }Property Value
Remarks
For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide .
Spot Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
Default: lowestPrice
Context
Reserved.
string? Context { get; }Property Value
Remarks
ExcessCapacityTerminationPolicy
Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
string? ExcessCapacityTerminationPolicy { get; }Property Value
Remarks
Supported only for fleets of type maintain .
IamFleetRole
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf.
string IamFleetRole { get; }Property Value
Remarks
For more information, see Spot Fleet Prerequisites in the Amazon EC2 User Guide . Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration .
InstanceInterruptionBehavior
The behavior when a Spot Instance is interrupted.
string? InstanceInterruptionBehavior { get; }Property Value
Remarks
InstancePoolsToUseCount
The number of Spot pools across which to allocate your target Spot capacity.
double? InstancePoolsToUseCount { get; }Property Value
Remarks
Valid only when Spot AllocationStrategy is set to lowest-price . Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
LaunchSpecifications
The launch specifications for the Spot Fleet request.
object? LaunchSpecifications { get; }Property Value
Remarks
If you specify LaunchSpecifications , you can't specify LaunchTemplateConfigs .
LaunchTemplateConfigs
The launch template and overrides.
object? LaunchTemplateConfigs { get; }Property Value
Remarks
If you specify LaunchTemplateConfigs , you can't specify LaunchSpecifications .
LoadBalancersConfig
One or more Classic Load Balancers and target groups to attach to the Spot Fleet request.
object? LoadBalancersConfig { get; }Property Value
Remarks
Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.
With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
OnDemandAllocationStrategy
The order of the launch template overrides to use in fulfilling On-Demand capacity.
string? OnDemandAllocationStrategy { get; }Property Value
Remarks
If you specify lowestPrice , Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized , Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice .
OnDemandMaxTotalPrice
The maximum amount per hour for On-Demand Instances that you're willing to pay.
string? OnDemandMaxTotalPrice { get; }Property Value
Remarks
You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.
If your fleet includes T instances that are configured as <code>unlimited</code> , and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The <code>onDemandMaxTotalPrice</code> does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for <code>onDemandMaxTotalPrice</code> . For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits">Surplus credits can incur charges</a> in the <em>Amazon EC2 User Guide</em> .
OnDemandTargetCapacity
The number of On-Demand units to request.
double? OnDemandTargetCapacity { get; }Property Value
Remarks
You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.
ReplaceUnhealthyInstances
Indicates whether Spot Fleet should replace unhealthy instances.
object? ReplaceUnhealthyInstances { get; }Property Value
Remarks
SpotMaintenanceStrategies
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
object? SpotMaintenanceStrategies { get; }Property Value
Remarks
SpotMaxTotalPrice
The maximum amount per hour for Spot Instances that you're willing to pay.
string? SpotMaxTotalPrice { get; }Property Value
Remarks
You can use the spotMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.
If your fleet includes T instances that are configured as <code>unlimited</code> , and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The <code>spotMaxTotalPrice</code> does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for <code>spotMaxTotalPrice</code> . For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits">Surplus credits can incur charges</a> in the <em>Amazon EC2 User Guide</em> .
SpotPrice
The maximum price per unit hour that you are willing to pay for a Spot Instance.
string? SpotPrice { get; }Property Value
Remarks
We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
TagSpecifications
The key-value pair for tagging the Spot Fleet request on creation.
object? TagSpecifications { get; }Property Value
Remarks
The value for ResourceType must be spot-fleet-request , otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs ) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications ). For information about tagging after launch, see Tag your resources .
TargetCapacity
The number of units to request for the Spot Fleet.
double TargetCapacity { get; }Property Value
Remarks
You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.
TargetCapacityUnitType
The unit for the target capacity. You can specify this parameter only when using attribute-based instance type selection.
string? TargetCapacityUnitType { get; }Property Value
Remarks
TerminateInstancesWithExpiration
Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
object? TerminateInstancesWithExpiration { get; }Property Value
Remarks
Type
The type of request.
string? Type { get; }Property Value
Remarks
Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request , the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain , the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain . instant is listed but is not used by Spot Fleet.
ValidFrom
The start date and time of the request, in UTC format ( YYYY - MM - DD T HH : MM : SS Z).
string? ValidFrom { get; }Property Value
Remarks
By default, Amazon EC2 starts fulfilling the request immediately.
ValidUntil
The end date and time of the request, in UTC format ( YYYY - MM - DD T HH : MM : SS Z).
string? ValidUntil { get; }Property Value
Remarks
After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.