CreateFleetRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ec2.model.Ec2Request
    - - software.amazon.awssdk.services.ec2.model.CreateFleetRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateFleetRequest
extends Ec2Request
implements ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateFleetRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateFleetRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateFleetRequest.Builder`	`builder()`
`String`	`clientToken()` Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`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.
`String`	`excessCapacityTerminationPolicyAsString()` 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.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLaunchTemplateConfigs()` Returns true if the LaunchTemplateConfigs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTagSpecifications()` Returns true if the TagSpecifications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<FleetLaunchTemplateConfigRequest>`	`launchTemplateConfigs()` The configuration for the EC2 Fleet.
`OnDemandOptionsRequest`	`onDemandOptions()` Describes the configuration of On-Demand Instances in an EC2 Fleet.
`Boolean`	`replaceUnhealthyInstances()` Indicates whether EC2 Fleet should replace unhealthy instances.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateFleetRequest.Builder>`	`serializableBuilderClass()`
`SpotOptionsRequest`	`spotOptions()` Describes the configuration of Spot Instances in an EC2 Fleet.
`List<TagSpecification>`	`tagSpecifications()` The key-value pair for tagging the EC2 Fleet request on creation.
`TargetCapacitySpecificationRequest`	`targetCapacitySpecification()` The number of units to request.
`Boolean`	`terminateInstancesWithExpiration()` Indicates whether running instances should be terminated when the EC2 Fleet expires.
`CreateFleetRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`FleetType`	`type()` The type of the request.
`String`	`typeAsString()` The type of the request.
`Instant`	`validFrom()` The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
`Instant`	`validUntil()` The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clientToken
```
public String clientToken()
```
    Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
    
    Returns:
    
    Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
  - spotOptions
```
public SpotOptionsRequest spotOptions()
```
    Describes the configuration of Spot Instances in an EC2 Fleet.
    
    Returns:
    
    Describes the configuration of Spot Instances in an EC2 Fleet.
  - onDemandOptions
```
public OnDemandOptionsRequest onDemandOptions()
```
    Describes the configuration of On-Demand Instances in an EC2 Fleet.
    
    Returns:
    
    Describes the configuration of On-Demand Instances in an EC2 Fleet.
  - excessCapacityTerminationPolicy
```
public 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.
    
    If the service returns an enum value that is not available in the current SDK version, excessCapacityTerminationPolicy will return FleetExcessCapacityTerminationPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from excessCapacityTerminationPolicyAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    FleetExcessCapacityTerminationPolicy
  - excessCapacityTerminationPolicyAsString
```
public String excessCapacityTerminationPolicyAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, excessCapacityTerminationPolicy will return FleetExcessCapacityTerminationPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from excessCapacityTerminationPolicyAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    FleetExcessCapacityTerminationPolicy
  - hasLaunchTemplateConfigs
```
public boolean hasLaunchTemplateConfigs()
```
    Returns true if the LaunchTemplateConfigs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - launchTemplateConfigs
```
public List<FleetLaunchTemplateConfigRequest> launchTemplateConfigs()
```
    The configuration for the EC2 Fleet.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasLaunchTemplateConfigs() to see if a value was sent in this field.
    
    Returns:
    
    The configuration for the EC2 Fleet.
  - targetCapacitySpecification
```
public TargetCapacitySpecificationRequest targetCapacitySpecification()
```
    The number of units to request.
    
    Returns:
    
    The number of units to request.
  - terminateInstancesWithExpiration
```
public Boolean terminateInstancesWithExpiration()
```
    Indicates whether running instances should be terminated when the EC2 Fleet expires.
    
    Returns:
    
    Indicates whether running instances should be terminated when the EC2 Fleet expires.
  - type
```
public FleetType type()
```
    The type of the request. By default, the EC2 Fleet places an asynchronous request for your desired capacity, and maintains it by replenishing interrupted Spot Instances (maintain). A value of instant places a synchronous one-time request, and returns errors for any instances that could not be launched. A value of request places an asynchronous one-time request without maintaining capacity or submitting requests in alternative capacity pools if capacity is unavailable. For more information, see EC2 Fleet Request Types in the Amazon Elastic Compute Cloud User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, type will return FleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the request. By default, the EC2 Fleet places an asynchronous request for your desired capacity, and maintains it by replenishing interrupted Spot Instances (maintain). A value of instant places a synchronous one-time request, and returns errors for any instances that could not be launched. A value of request places an asynchronous one-time request without maintaining capacity or submitting requests in alternative capacity pools if capacity is unavailable. For more information, see EC2 Fleet Request Types in the Amazon Elastic Compute Cloud User Guide.
    
    See Also:
    
    FleetType
  - typeAsString
```
public String typeAsString()
```
    The type of the request. By default, the EC2 Fleet places an asynchronous request for your desired capacity, and maintains it by replenishing interrupted Spot Instances (maintain). A value of instant places a synchronous one-time request, and returns errors for any instances that could not be launched. A value of request places an asynchronous one-time request without maintaining capacity or submitting requests in alternative capacity pools if capacity is unavailable. For more information, see EC2 Fleet Request Types in the Amazon Elastic Compute Cloud User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, type will return FleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the request. By default, the EC2 Fleet places an asynchronous request for your desired capacity, and maintains it by replenishing interrupted Spot Instances (maintain). A value of instant places a synchronous one-time request, and returns errors for any instances that could not be launched. A value of request places an asynchronous one-time request without maintaining capacity or submitting requests in alternative capacity pools if capacity is unavailable. For more information, see EC2 Fleet Request Types in the Amazon Elastic Compute Cloud User Guide.
    
    See Also:
    
    FleetType
  - validFrom
```
public 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.
    
    Returns:
    
    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.
  - validUntil
```
public 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.
    
    Returns:
    
    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.
  - replaceUnhealthyInstances
```
public Boolean replaceUnhealthyInstances()
```
    Indicates whether EC2 Fleet should replace unhealthy instances.
    
    Returns:
    
    Indicates whether EC2 Fleet should replace unhealthy instances.
  - hasTagSpecifications
```
public boolean hasTagSpecifications()
```
    Returns true if the TagSpecifications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tagSpecifications
```
public List<TagSpecification> tagSpecifications()
```
    The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType must be fleet, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch template. For information about tagging after launch, see Tagging Your Resources.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTagSpecifications() to see if a value was sent in this field.
    
    Returns:
    
    The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType must be fleet, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch template. For information about tagging after launch, see Tagging Your Resources.
  - toBuilder
```
public CreateFleetRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static CreateFleetRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateFleetRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateFleetRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

clientToken

spotOptions

onDemandOptions

excessCapacityTerminationPolicy

excessCapacityTerminationPolicyAsString

hasLaunchTemplateConfigs

launchTemplateConfigs

targetCapacitySpecification

terminateInstancesWithExpiration

type

typeAsString

validFrom

validUntil

replaceUnhealthyInstances

hasTagSpecifications

tagSpecifications

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields