software.amazon.awssdk.services.ec2.model

Interface CreateFleetRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>, Ec2Request.Builder, SdkBuilder<CreateFleetRequest.Builder,CreateFleetRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateFleetRequest

public static interface CreateFleetRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>

Method Summary

Modifier and Type	Method and Description
CreateFleetRequest.Builder	clientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateFleetRequest.Builder	context(String context) Reserved.
CreateFleetRequest.Builder	dryRun(Boolean dryRun) Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
CreateFleetRequest.Builder	excessCapacityTerminationPolicy(FleetExcessCapacityTerminationPolicy excessCapacityTerminationPolicy) 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.
CreateFleetRequest.Builder	excessCapacityTerminationPolicy(String excessCapacityTerminationPolicy) 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.
CreateFleetRequest.Builder	launchTemplateConfigs(Collection<FleetLaunchTemplateConfigRequest> launchTemplateConfigs) The configuration for the EC2 Fleet.
CreateFleetRequest.Builder	launchTemplateConfigs(Consumer<FleetLaunchTemplateConfigRequest.Builder>... launchTemplateConfigs) The configuration for the EC2 Fleet.
CreateFleetRequest.Builder	launchTemplateConfigs(FleetLaunchTemplateConfigRequest... launchTemplateConfigs) The configuration for the EC2 Fleet.
default CreateFleetRequest.Builder	onDemandOptions(Consumer<OnDemandOptionsRequest.Builder> onDemandOptions) Describes the configuration of On-Demand Instances in an EC2 Fleet.
CreateFleetRequest.Builder	onDemandOptions(OnDemandOptionsRequest onDemandOptions) Describes the configuration of On-Demand Instances in an EC2 Fleet.
CreateFleetRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateFleetRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateFleetRequest.Builder	replaceUnhealthyInstances(Boolean replaceUnhealthyInstances) Indicates whether EC2 Fleet should replace unhealthy Spot Instances.
default CreateFleetRequest.Builder	spotOptions(Consumer<SpotOptionsRequest.Builder> spotOptions) Describes the configuration of Spot Instances in an EC2 Fleet.
CreateFleetRequest.Builder	spotOptions(SpotOptionsRequest spotOptions) Describes the configuration of Spot Instances in an EC2 Fleet.
CreateFleetRequest.Builder	tagSpecifications(Collection<TagSpecification> tagSpecifications) The key-value pair for tagging the EC2 Fleet request on creation.
CreateFleetRequest.Builder	tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications) The key-value pair for tagging the EC2 Fleet request on creation.
CreateFleetRequest.Builder	tagSpecifications(TagSpecification... tagSpecifications) The key-value pair for tagging the EC2 Fleet request on creation.
default CreateFleetRequest.Builder	targetCapacitySpecification(Consumer<TargetCapacitySpecificationRequest.Builder> targetCapacitySpecification) The number of units to request.
CreateFleetRequest.Builder	targetCapacitySpecification(TargetCapacitySpecificationRequest targetCapacitySpecification) The number of units to request.
CreateFleetRequest.Builder	terminateInstancesWithExpiration(Boolean terminateInstancesWithExpiration) Indicates whether running instances should be terminated when the EC2 Fleet expires.
CreateFleetRequest.Builder	type(FleetType type) The fleet type.
CreateFleetRequest.Builder	type(String type) The fleet type.
CreateFleetRequest.Builder	validFrom(Instant validFrom) The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
CreateFleetRequest.Builder	validUntil(Instant validUntil) The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

dryRun

CreateFleetRequest.Builder dryRun(Boolean dryRun)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Parameters:

dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientToken

CreateFleetRequest.Builder clientToken(String clientToken)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

Parameters:

clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

Returns:

Returns a reference to this object so that method calls can be chained together.

spotOptions

CreateFleetRequest.Builder spotOptions(SpotOptionsRequest spotOptions)

Describes the configuration of Spot Instances in an EC2 Fleet.

Parameters:

spotOptions - Describes the configuration of Spot Instances in an EC2 Fleet.

Returns:

Returns a reference to this object so that method calls can be chained together.

spotOptions

default CreateFleetRequest.Builder spotOptions(Consumer<SpotOptionsRequest.Builder> spotOptions)

Describes the configuration of Spot Instances in an EC2 Fleet.

This is a convenience method that creates an instance of the SpotOptionsRequest.Builder avoiding the need to create one manually via SpotOptionsRequest.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to spotOptions(SpotOptionsRequest).

Parameters:

spotOptions - a consumer that will call methods on SpotOptionsRequest.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

spotOptions(SpotOptionsRequest)

onDemandOptions

CreateFleetRequest.Builder onDemandOptions(OnDemandOptionsRequest onDemandOptions)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

onDemandOptions

default CreateFleetRequest.Builder onDemandOptions(Consumer<OnDemandOptionsRequest.Builder> onDemandOptions)

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

This is a convenience method that creates an instance of the OnDemandOptionsRequest.Builder avoiding the need to create one manually via OnDemandOptionsRequest.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to onDemandOptions(OnDemandOptionsRequest).

Parameters:

onDemandOptions - a consumer that will call methods on OnDemandOptionsRequest.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

onDemandOptions(OnDemandOptionsRequest)

excessCapacityTerminationPolicy

CreateFleetRequest.Builder excessCapacityTerminationPolicy(String excessCapacityTerminationPolicy)

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.

Parameters:

excessCapacityTerminationPolicy - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FleetExcessCapacityTerminationPolicy, FleetExcessCapacityTerminationPolicy

excessCapacityTerminationPolicy

CreateFleetRequest.Builder excessCapacityTerminationPolicy(FleetExcessCapacityTerminationPolicy excessCapacityTerminationPolicy)

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.

Parameters:

excessCapacityTerminationPolicy - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FleetExcessCapacityTerminationPolicy, FleetExcessCapacityTerminationPolicy

launchTemplateConfigs

CreateFleetRequest.Builder launchTemplateConfigs(Collection<FleetLaunchTemplateConfigRequest> launchTemplateConfigs)

The configuration for the EC2 Fleet.

Parameters:

launchTemplateConfigs - The configuration for the EC2 Fleet.

Returns:

Returns a reference to this object so that method calls can be chained together.

launchTemplateConfigs

CreateFleetRequest.Builder launchTemplateConfigs(FleetLaunchTemplateConfigRequest... launchTemplateConfigs)

The configuration for the EC2 Fleet.

Parameters:

launchTemplateConfigs - The configuration for the EC2 Fleet.

Returns:

Returns a reference to this object so that method calls can be chained together.

launchTemplateConfigs

CreateFleetRequest.Builder launchTemplateConfigs(Consumer<FleetLaunchTemplateConfigRequest.Builder>... launchTemplateConfigs)

The configuration for the EC2 Fleet.

This is a convenience method that creates an instance of the FleetLaunchTemplateConfigRequest.Builder avoiding the need to create one manually via FleetLaunchTemplateConfigRequest.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #launchTemplateConfigs(List).

Parameters:

launchTemplateConfigs - a consumer that will call methods on FleetLaunchTemplateConfigRequest.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#launchTemplateConfigs(java.util.Collection)

targetCapacitySpecification

CreateFleetRequest.Builder targetCapacitySpecification(TargetCapacitySpecificationRequest targetCapacitySpecification)

The number of units to request.

Parameters:

targetCapacitySpecification - The number of units to request.

Returns:

Returns a reference to this object so that method calls can be chained together.

targetCapacitySpecification

default CreateFleetRequest.Builder targetCapacitySpecification(Consumer<TargetCapacitySpecificationRequest.Builder> targetCapacitySpecification)

The number of units to request.

This is a convenience method that creates an instance of the TargetCapacitySpecificationRequest.Builder avoiding the need to create one manually via TargetCapacitySpecificationRequest.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetCapacitySpecification(TargetCapacitySpecificationRequest).

Parameters:

targetCapacitySpecification - a consumer that will call methods on TargetCapacitySpecificationRequest.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

targetCapacitySpecification(TargetCapacitySpecificationRequest)

terminateInstancesWithExpiration

CreateFleetRequest.Builder terminateInstancesWithExpiration(Boolean terminateInstancesWithExpiration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

type

CreateFleetRequest.Builder type(String type)

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.

Parameters:

type - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FleetType, FleetType

type

CreateFleetRequest.Builder type(FleetType type)

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.

Parameters:

type - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FleetType, FleetType

validFrom

CreateFleetRequest.Builder validFrom(Instant validFrom)

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.

Parameters:

validFrom - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

validUntil

CreateFleetRequest.Builder validUntil(Instant validUntil)

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.

Parameters:

validUntil - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

replaceUnhealthyInstances

CreateFleetRequest.Builder replaceUnhealthyInstances(Boolean replaceUnhealthyInstances)

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.

Parameters:

replaceUnhealthyInstances - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagSpecifications

CreateFleetRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

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.

Parameters:

tagSpecifications - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagSpecifications

CreateFleetRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

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.

Parameters:

tagSpecifications - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagSpecifications

CreateFleetRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

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.

This is a convenience method that creates an instance of the TagSpecification.Builder avoiding the need to create one manually via TagSpecification.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tagSpecifications(List).

Parameters:

tagSpecifications - a consumer that will call methods on TagSpecification.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tagSpecifications(java.util.Collection)

context

CreateFleetRequest.Builder context(String context)

Reserved.

Parameters:

context - Reserved.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateFleetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateFleetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder