Fleet class

Provides a resource to manage EC2 Fleets.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ec2.Fleet("example", {
    targetCapacitySpecification: {
        defaultTargetCapacityType: "spot",
        totalTargetCapacity: 5,
    },
    launchTemplateConfigs: [{
        launchTemplateSpecification: {
            launchTemplateId: exampleAwsLaunchTemplate.id,
            version: exampleAwsLaunchTemplate.latestVersion,
        },
    }],
});
import pulumi
import pulumi_aws as aws

example = aws.ec2.Fleet("example",
    target_capacity_specification={
        "default_target_capacity_type": "spot",
        "total_target_capacity": 5,
    },
    launch_template_configs=[{
        "launch_template_specification": {
            "launch_template_id": example_aws_launch_template["id"],
            "version": example_aws_launch_template["latestVersion"],
        },
    }])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Ec2.Fleet("example", new()
    {
        TargetCapacitySpecification = new Aws.Ec2.Inputs.FleetTargetCapacitySpecificationArgs
        {
            DefaultTargetCapacityType = "spot",
            TotalTargetCapacity = 5,
        },
        LaunchTemplateConfigs = new[]
        {
            new Aws.Ec2.Inputs.FleetLaunchTemplateConfigArgs
            {
                LaunchTemplateSpecification = new Aws.Ec2.Inputs.FleetLaunchTemplateConfigLaunchTemplateSpecificationArgs
                {
                    LaunchTemplateId = exampleAwsLaunchTemplate.Id,
                    Version = exampleAwsLaunchTemplate.LatestVersion,
                },
            },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewFleet(ctx, "example", &ec2.FleetArgs{
			TargetCapacitySpecification: &ec2.FleetTargetCapacitySpecificationArgs{
				DefaultTargetCapacityType: pulumi.String("spot"),
				TotalTargetCapacity:       pulumi.Int(5),
			},
			LaunchTemplateConfigs: ec2.FleetLaunchTemplateConfigArray{
				&ec2.FleetLaunchTemplateConfigArgs{
					LaunchTemplateSpecification: &ec2.FleetLaunchTemplateConfigLaunchTemplateSpecificationArgs{
						LaunchTemplateId: pulumi.Any(exampleAwsLaunchTemplate.Id),
						Version:          pulumi.Any(exampleAwsLaunchTemplate.LatestVersion),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ec2_fleet" "example" {
  target_capacity_specification = {
    default_target_capacity_type = "spot"
    total_target_capacity        = 5
  }
  launch_template_configs {
    launch_template_specification = {
      launch_template_id = exampleAwsLaunchTemplate.id
      version            = exampleAwsLaunchTemplate.latestVersion
    }
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Fleet;
import com.pulumi.aws.ec2.FleetArgs;
import com.pulumi.aws.ec2.inputs.FleetTargetCapacitySpecificationArgs;
import com.pulumi.aws.ec2.inputs.FleetLaunchTemplateConfigArgs;
import com.pulumi.aws.ec2.inputs.FleetLaunchTemplateConfigLaunchTemplateSpecificationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Fleet("example", FleetArgs.builder()
            .targetCapacitySpecification(FleetTargetCapacitySpecificationArgs.builder()
                .defaultTargetCapacityType("spot")
                .totalTargetCapacity(5)
                .build())
            .launchTemplateConfigs(FleetLaunchTemplateConfigArgs.builder()
                .launchTemplateSpecification(FleetLaunchTemplateConfigLaunchTemplateSpecificationArgs.builder()
                    .launchTemplateId(exampleAwsLaunchTemplate.id())
                    .version(exampleAwsLaunchTemplate.latestVersion())
                    .build())
                .build())
            .build());

    }
}
resources:
  example:
    type: aws:ec2:Fleet
    properties:
      targetCapacitySpecification:
        defaultTargetCapacityType: spot
        totalTargetCapacity: 5
      launchTemplateConfigs:
        - launchTemplateSpecification:
            launchTemplateId: ${exampleAwsLaunchTemplate.id}
            version: ${exampleAwsLaunchTemplate.latestVersion}

Import

Using pulumi import, import aws.ec2.Fleet using the Fleet identifier. For example:

$ pulumi import aws:ec2/fleet:Fleet example fleet-b9b55d27-c5fc-41ac-a6f3-48fcc91f080c

Constructors

Fleet(String name, {FleetArgs? args, CustomResourceOptions? options})
Creates a new Fleet. name The Pulumi resource name. args Arguments used to configure this Fleet. The set of arguments for Fleet. options Resource options controlling this resource's behavior.
Fleet.reference(String urn)
Creates a typed reference to an existing Fleet resource.

Properties

arn ↔ Output<String>
The ARN of the fleet
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
context ↔ Output<String?>
Reserved.
latefinal
excessCapacityTerminationPolicy ↔ Output<String?>
Whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2. Valid values: no-termination, termination. Defaults to termination. Supported only for fleets of type maintain.
latefinal
fleetInstanceSets ↔ Output<List<FleetFleetInstanceSet>>
Information about the instances that were launched by the fleet. Available only when type is set to instant.
latefinal
fleetState ↔ Output<String>
The state of the EC2 Fleet.
latefinal
fulfilledCapacity ↔ Output<double>
The number of units fulfilled by this request compared to the set target capacity.
latefinal
fulfilledOnDemandCapacity ↔ Output<double>
The number of units fulfilled by this request compared to the set target On-Demand capacity.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
launchTemplateConfigs ↔ Output<List<FleetLaunchTemplateConfig>>
Nested argument containing EC2 Launch Template configurations. Defined below.
latefinal
onDemandOptions ↔ Output<FleetOnDemandOptions?>
Nested argument containing On-Demand configurations. Defined below.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
replaceUnhealthyInstances ↔ Output<bool?>
Whether EC2 Fleet should replace unhealthy instances. Defaults to false. Supported only for fleets of type maintain.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
spotOptions ↔ Output<FleetSpotOptions?>
Nested argument containing Spot configurations. Defined below.
latefinal
tags ↔ Output<Map<String, String>?>
Map of Fleet tags. To tag instances at launch, specify the tags in the Launch Template. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
targetCapacitySpecification ↔ Output<FleetTargetCapacitySpecification>
Nested argument containing target capacity configurations. Defined below.
latefinal
terminateInstances ↔ Output<bool?>
Whether to terminate instances for an EC2 Fleet if it is deleted successfully. Defaults to false.
latefinal
terminateInstancesWithExpiration ↔ Output<bool?>
Whether running instances should be terminated when the EC2 Fleet expires. Defaults to false.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
type ↔ Output<String?>
The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. Valid values: maintain, request, instant. Defaults to maintain.
latefinal
urn ↔ Output<String>
latefinalinherited
validFrom ↔ Output<String?>
The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.
latefinal
validUntil ↔ Output<String?>
The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). 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.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {FleetState? state, CustomResourceOptions? options}) → Fleet
Gets an existing Fleet resource's state with the given name and id.