interface CfnEC2FleetProps

Language	Type name
.NET	`Amazon.CDK.AWS.EC2.CfnEC2FleetProps`
Java	`software.amazon.awscdk.services.ec2.CfnEC2FleetProps`
Python	`aws_cdk.aws_ec2.CfnEC2FleetProps`
TypeScript	`@aws-cdk/aws-ec2` » `CfnEC2FleetProps`

Properties for defining a CfnEC2Fleet.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ec2 from '@aws-cdk/aws-ec2';
const cfnEC2FleetProps: ec2.CfnEC2FleetProps = {
  launchTemplateConfigs: [{
    launchTemplateSpecification: {
      version: 'version',

      // the properties below are optional
      launchTemplateId: 'launchTemplateId',
      launchTemplateName: 'launchTemplateName',
    },
    overrides: [{
      availabilityZone: 'availabilityZone',
      instanceRequirements: {
        acceleratorCount: {
          max: 123,
          min: 123,
        },
        acceleratorManufacturers: ['acceleratorManufacturers'],
        acceleratorNames: ['acceleratorNames'],
        acceleratorTotalMemoryMiB: {
          max: 123,
          min: 123,
        },
        acceleratorTypes: ['acceleratorTypes'],
        allowedInstanceTypes: ['allowedInstanceTypes'],
        bareMetal: 'bareMetal',
        baselineEbsBandwidthMbps: {
          max: 123,
          min: 123,
        },
        burstablePerformance: 'burstablePerformance',
        cpuManufacturers: ['cpuManufacturers'],
        excludedInstanceTypes: ['excludedInstanceTypes'],
        instanceGenerations: ['instanceGenerations'],
        localStorage: 'localStorage',
        localStorageTypes: ['localStorageTypes'],
        memoryGiBPerVCpu: {
          max: 123,
          min: 123,
        },
        memoryMiB: {
          max: 123,
          min: 123,
        },
        networkBandwidthGbps: {
          max: 123,
          min: 123,
        },
        networkInterfaceCount: {
          max: 123,
          min: 123,
        },
        onDemandMaxPricePercentageOverLowestPrice: 123,
        requireHibernateSupport: false,
        spotMaxPricePercentageOverLowestPrice: 123,
        totalLocalStorageGb: {
          max: 123,
          min: 123,
        },
        vCpuCount: {
          max: 123,
          min: 123,
        },
      },
      instanceType: 'instanceType',
      maxPrice: 'maxPrice',
      placement: {
        affinity: 'affinity',
        availabilityZone: 'availabilityZone',
        groupName: 'groupName',
        hostId: 'hostId',
        hostResourceGroupArn: 'hostResourceGroupArn',
        partitionNumber: 123,
        spreadDomain: 'spreadDomain',
        tenancy: 'tenancy',
      },
      priority: 123,
      subnetId: 'subnetId',
      weightedCapacity: 123,
    }],
  }],
  targetCapacitySpecification: {
    totalTargetCapacity: 123,

    // the properties below are optional
    defaultTargetCapacityType: 'defaultTargetCapacityType',
    onDemandTargetCapacity: 123,
    spotTargetCapacity: 123,
    targetCapacityUnitType: 'targetCapacityUnitType',
  },

  // the properties below are optional
  context: 'context',
  excessCapacityTerminationPolicy: 'excessCapacityTerminationPolicy',
  onDemandOptions: {
    allocationStrategy: 'allocationStrategy',
    capacityReservationOptions: {
      usageStrategy: 'usageStrategy',
    },
    maxTotalPrice: 'maxTotalPrice',
    minTargetCapacity: 123,
    singleAvailabilityZone: false,
    singleInstanceType: false,
  },
  replaceUnhealthyInstances: false,
  spotOptions: {
    allocationStrategy: 'allocationStrategy',
    instanceInterruptionBehavior: 'instanceInterruptionBehavior',
    instancePoolsToUseCount: 123,
    maintenanceStrategies: {
      capacityRebalance: {
        replacementStrategy: 'replacementStrategy',
        terminationDelay: 123,
      },
    },
    maxTotalPrice: 'maxTotalPrice',
    minTargetCapacity: 123,
    singleAvailabilityZone: false,
    singleInstanceType: false,
  },
  tagSpecifications: [{
    resourceType: 'resourceType',
    tags: [{
      key: 'key',
      value: 'value',
    }],
  }],
  terminateInstancesWithExpiration: false,
  type: 'type',
  validFrom: 'validFrom',
  validUntil: 'validUntil',
};

Properties

Name	Type	Description
launchTemplateConfigs	`IResolvable` `\|` `IResolvable` `\|` `FleetLaunchTemplateConfigRequestProperty[]`	The configuration for the EC2 Fleet.
targetCapacitySpecification	`IResolvable` `\|` `TargetCapacitySpecificationRequestProperty`	The number of units to request.
context?	`string`	Reserved.
excessCapacityTerminationPolicy?	`string`	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.
onDemandOptions?	`IResolvable` `\|` `OnDemandOptionsRequestProperty`	Describes the configuration of On-Demand Instances in an EC2 Fleet.
replaceUnhealthyInstances?	`boolean \|` `IResolvable`	Indicates whether EC2 Fleet should replace unhealthy Spot Instances.
spotOptions?	`IResolvable` `\|` `SpotOptionsRequestProperty`	Describes the configuration of Spot Instances in an EC2 Fleet.
tagSpecifications?	`IResolvable` `\|` `IResolvable` `\|` `TagSpecificationProperty[]`	The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tagging your resources .
terminateInstancesWithExpiration?	`boolean \|` `IResolvable`	Indicates whether running instances should be terminated when the EC2 Fleet expires.
type?	`string`	The fleet type. The default value is `maintain` .
validFrom?	`string`	The start date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).
validUntil?	`string`	The end date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).

launchTemplateConfigs

Type: IResolvable | IResolvable | FleetLaunchTemplateConfigRequestProperty[]

The configuration for the EC2 Fleet.

targetCapacitySpecification

Type: IResolvable | TargetCapacitySpecificationRequestProperty

The number of units to request.

context?

Type: string (optional)

Reserved.

excessCapacityTerminationPolicy?

Type: string (optional)

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.

Supported only for fleets of type maintain .

onDemandOptions?

Type: IResolvable | OnDemandOptionsRequestProperty (optional)

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

replaceUnhealthyInstances?

Type: boolean | IResolvable (optional)

Indicates whether EC2 Fleet should replace unhealthy Spot Instances.

Supported only for fleets of type maintain . For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide .

spotOptions?

Type: IResolvable | SpotOptionsRequestProperty (optional)

Describes the configuration of Spot Instances in an EC2 Fleet.

tagSpecifications?

Type: IResolvable | IResolvable | TagSpecificationProperty[] (optional)

The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tagging your resources .

If the fleet type is instant , specify a resource type of fleet to tag the fleet or instance to tag the instances at launch.

If the fleet type is maintain or request , specify a resource type of fleet to tag the fleet. You cannot specify a resource type of instance . To tag instances at launch, specify the tags in a launch template .

terminateInstancesWithExpiration?

Type: boolean | IResolvable (optional)

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

type?

Type: string (optional)

The fleet type. The default value is maintain .

maintain - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances.
request - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted.
instant - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.

For more information, see EC2 Fleet request types in the Amazon EC2 User Guide .

validFrom?

Type: string (optional)

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

The default is to start fulfilling the request immediately.

validUntil?

Type: string (optional)

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

At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.