aws-cdk-lib.aws_ec2.CfnEC2Fleet

class CfnEC2Fleet (construct)

LanguageType name
.NETAmazon.CDK.AWS.EC2.CfnEC2Fleet
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnEC2Fleet
Javasoftware.amazon.awscdk.services.ec2.CfnEC2Fleet
Pythonaws_cdk.aws_ec2.CfnEC2Fleet
TypeScript aws-cdk-lib » aws_ec2 » CfnEC2Fleet

Implements IConstruct, IDependable, IInspectable

A CloudFormation AWS::EC2::EC2Fleet.

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 { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnEC2Fleet = new ec2.CfnEC2Fleet(this, 'MyCfnEC2Fleet', {
  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',
});

Initializer

new CfnEC2Fleet(scope: Construct, id: string, props: CfnEC2FleetProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnEC2FleetProps — - resource properties.

Create a new AWS::EC2::EC2Fleet.

Construct Props

NameTypeDescription
launchTemplateConfigsIResolvable | IResolvable | FleetLaunchTemplateConfigRequestProperty[]The configuration for the EC2 Fleet.
targetCapacitySpecificationIResolvable | TargetCapacitySpecificationRequestPropertyThe number of units to request.
context?stringReserved.
excessCapacityTerminationPolicy?stringIndicates 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 | OnDemandOptionsRequestPropertyDescribes the configuration of On-Demand Instances in an EC2 Fleet.
replaceUnhealthyInstances?boolean | IResolvableIndicates whether EC2 Fleet should replace unhealthy Spot Instances.
spotOptions?IResolvable | SpotOptionsRequestPropertyDescribes 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 | IResolvableIndicates whether running instances should be terminated when the EC2 Fleet expires.
type?stringThe fleet type. The default value is maintain .
validFrom?stringThe start date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).
validUntil?stringThe 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.

Properties

NameTypeDescription
attrFleetIdstringThe ID of the EC2 Fleet.
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
launchTemplateConfigsIResolvable | IResolvable | FleetLaunchTemplateConfigRequestProperty[]The configuration for the EC2 Fleet.
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeNodeThe tree node.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
stackStackThe stack in which this element is defined.
targetCapacitySpecificationIResolvable | TargetCapacitySpecificationRequestPropertyThe number of units to request.
context?stringReserved.
excessCapacityTerminationPolicy?stringIndicates 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 | OnDemandOptionsRequestPropertyDescribes the configuration of On-Demand Instances in an EC2 Fleet.
replaceUnhealthyInstances?boolean | IResolvableIndicates whether EC2 Fleet should replace unhealthy Spot Instances.
spotOptions?IResolvable | SpotOptionsRequestPropertyDescribes 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 | IResolvableIndicates whether running instances should be terminated when the EC2 Fleet expires.
type?stringThe fleet type. The default value is maintain .
validFrom?stringThe start date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).
validUntil?stringThe end date and time of the request, in UTC format (for example, YYYY - MM - DD T HH : MM : SS Z).
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrFleetId

Type: string

The ID of the EC2 Fleet.


cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.


cfnProperties

Type: { [string]: any }


cfnResourceType

Type: string

AWS resource type.


creationStack

Type: string[]


launchTemplateConfigs

Type: IResolvable | IResolvable | FleetLaunchTemplateConfigRequestProperty[]

The configuration for the EC2 Fleet.


logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


node

Type: Node

The tree node.


ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).


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.


static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependency(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
obtainDependencies()Retrieves an array of resources this resource depends on.
obtainResourceDependencies()Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)Replaces one dependency with another.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).


addDependency(target)

public addDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.


addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.


addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.


addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.


addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).


applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

  • policy RemovalPolicy
  • options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options


getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

  • attributeName string — The name of the attribute.
  • typeHint ResolutionTypeHint

Returns

  • Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.


getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.


obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

  • Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.


obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

  • CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.


overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.


removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.


replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

  • target CfnResource — The dependency to replace.
  • newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }