Package software.amazon.awssdk.services.ec2.model

Class FleetData

java.lang.Object
software.amazon.awssdk.services.ec2.model.FleetData
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FleetData.Builder,FleetData>
@Generated("software.amazon.awssdk:codegen") public final class FleetData extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FleetData.Builder,FleetData>

Describes an EC2 Fleet.

See Also:

  • Method Details

    • activityStatus

      public final FleetActivityStatus activityStatus()

      The progress of the EC2 Fleet. If there is an error, the status is error. After all requests are placed, the status is pending_fulfillment. If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating.

      If the service returns an enum value that is not available in the current SDK version, activityStatus will return FleetActivityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activityStatusAsString().

      Returns:
      The progress of the EC2 Fleet. If there is an error, the status is error. After all requests are placed, the status is pending_fulfillment. If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating.
      See Also:

    • activityStatusAsString

      public final String activityStatusAsString()

      The progress of the EC2 Fleet. If there is an error, the status is error. After all requests are placed, the status is pending_fulfillment. If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating.

      If the service returns an enum value that is not available in the current SDK version, activityStatus will return FleetActivityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from activityStatusAsString().

      Returns:
      The progress of the EC2 Fleet. If there is an error, the status is error. After all requests are placed, the status is pending_fulfillment. If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating.
      See Also:

    • createTime

      public final Instant createTime()

      The creation date and time of the EC2 Fleet.

      Returns:
      The creation date and time of the EC2 Fleet.

    • fleetId

      public final String fleetId()

      The ID of the EC2 Fleet.

      Returns:
      The ID of the EC2 Fleet.

    • fleetState

      public final FleetStateCode fleetState()

      The state of the EC2 Fleet.

      If the service returns an enum value that is not available in the current SDK version, fleetState will return FleetStateCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fleetStateAsString().

      Returns:
      The state of the EC2 Fleet.
      See Also:

    • fleetStateAsString

      public final String fleetStateAsString()

      The state of the EC2 Fleet.

      If the service returns an enum value that is not available in the current SDK version, fleetState will return FleetStateCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fleetStateAsString().

      Returns:
      The state of the EC2 Fleet.
      See Also:

    • clientToken

      public final String clientToken()

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

      Constraints: Maximum 64 ASCII characters

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

      Constraints: Maximum 64 ASCII characters

    • excessCapacityTerminationPolicy

      public final FleetExcessCapacityTerminationPolicy excessCapacityTerminationPolicy()

      Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

      Supported only for fleets of type maintain.

      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 target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

      Supported only for fleets of type maintain.

      See Also:

    • excessCapacityTerminationPolicyAsString

      public final String excessCapacityTerminationPolicyAsString()

      Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

      Supported only for fleets of type maintain.

      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 target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

      Supported only for fleets of type maintain.

      See Also:

    • fulfilledCapacity

      public final Double fulfilledCapacity()

      The number of units fulfilled by this request compared to the set target capacity.

      Returns:
      The number of units fulfilled by this request compared to the set target capacity.

    • fulfilledOnDemandCapacity

      public final Double fulfilledOnDemandCapacity()

      The number of units fulfilled by this request compared to the set target On-Demand capacity.

      Returns:
      The number of units fulfilled by this request compared to the set target On-Demand capacity.

    • hasLaunchTemplateConfigs

      public final boolean hasLaunchTemplateConfigs()
      For responses, this returns true if the service returned a value for the LaunchTemplateConfigs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • launchTemplateConfigs

      public final List<FleetLaunchTemplateConfig> launchTemplateConfigs()

      The launch template and overrides.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLaunchTemplateConfigs() method.

      Returns:
      The launch template and overrides.

    • targetCapacitySpecification

      public final TargetCapacitySpecification targetCapacitySpecification()

      The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

      Returns:
      The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

    • terminateInstancesWithExpiration

      public final 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 final FleetType type()

      The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain.

      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 request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain.

      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 request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain.
      See Also:

    • validFrom

      public final 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 final 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 instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.

      Returns:
      The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.

    • replaceUnhealthyInstances

      public final 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.

      Returns:
      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

      public final SpotOptions spotOptions()

      The configuration of Spot Instances in an EC2 Fleet.

      Returns:
      The configuration of Spot Instances in an EC2 Fleet.

    • onDemandOptions

      public final OnDemandOptions onDemandOptions()

      The allocation strategy of On-Demand Instances in an EC2 Fleet.

      Returns:
      The allocation strategy of On-Demand Instances in an EC2 Fleet.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      The tags for an EC2 Fleet resource.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tags for an EC2 Fleet resource.

    • hasErrors

      public final boolean hasErrors()
      For responses, this returns true if the service returned a value for the Errors property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • errors

      public final List<DescribeFleetError> errors()

      Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasErrors() method.

      Returns:
      Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant.

    • hasInstances

      public final boolean hasInstances()
      For responses, this returns true if the service returned a value for the Instances property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • instances

      public final List<DescribeFleetsInstances> instances()

      Information about the instances that were launched by the fleet. Valid only when Type is set to instant.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstances() method.

      Returns:
      Information about the instances that were launched by the fleet. Valid only when Type is set to instant.

    • context

      public final String context()

      Reserved.

      Returns:
      Reserved.

    • toBuilder

      public FleetData.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FleetData.Builder,FleetData>
      Returns:
      a builder for type T

    • builder

      public static FleetData.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FleetData.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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 final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.