Class CreateCapacityReservationFleetRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateCapacityReservationFleetRequest.Builder,
CreateCapacityReservationFleetRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use.builder()
final String
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.final Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.final Instant
endDate()
The date and time at which the Capacity Reservation Fleet expires.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InstanceTypeSpecifications property.final boolean
For responses, this returns true if the service returned a value for the TagSpecifications property.Indicates the type of instance launches that the Capacity Reservation Fleet accepts.final String
Indicates the type of instance launches that the Capacity Reservation Fleet accepts.Information about the instance types for which to reserve the capacity.static Class
<? extends CreateCapacityReservationFleetRequest.Builder> final List
<TagSpecification> The tags to assign to the Capacity Reservation Fleet.tenancy()
Indicates the tenancy of the Capacity Reservation Fleet.final String
Indicates the tenancy of the Capacity Reservation Fleet.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
The total number of capacity units to be reserved by the Capacity Reservation Fleet.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
allocationStrategy
The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. Currently, only the
prioritized
allocation strategy is supported. For more information, see Allocation strategy in the Amazon EC2 User Guide.Valid values:
prioritized
- Returns:
- The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to
use. Currently, only the
prioritized
allocation strategy is supported. For more information, see Allocation strategy in the Amazon EC2 User Guide.Valid values:
prioritized
-
clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
- Returns:
- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
-
hasInstanceTypeSpecifications
public final boolean hasInstanceTypeSpecifications()For responses, this returns true if the service returned a value for the InstanceTypeSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
instanceTypeSpecifications
Information about the instance types for which to reserve the capacity.
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
hasInstanceTypeSpecifications()
method.- Returns:
- Information about the instance types for which to reserve the capacity.
-
tenancy
Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:
-
default
- The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts. -
dedicated
- The Capacity Reservations are created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
If the service returns an enum value that is not available in the current SDK version,
tenancy
will returnFleetCapacityReservationTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtenancyAsString()
.- Returns:
- Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit
this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:
-
default
- The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts. -
dedicated
- The Capacity Reservations are created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
-
- See Also:
-
-
tenancyAsString
Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:
-
default
- The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts. -
dedicated
- The Capacity Reservations are created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
If the service returns an enum value that is not available in the current SDK version,
tenancy
will returnFleetCapacityReservationTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtenancyAsString()
.- Returns:
- Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit
this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:
-
default
- The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts. -
dedicated
- The Capacity Reservations are created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
-
- See Also:
-
-
totalTargetCapacity
The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the Amazon EC2 User Guide.
- Returns:
- The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the Amazon EC2 User Guide.
-
endDate
The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to
expired
and all of the Capacity Reservations in the Fleet expire.The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify
5/31/2019
,13:30:55
, the Capacity Reservation Fleet is guaranteed to expire between13:30:55
and14:30:55
on5/31/2019
.- Returns:
- The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet
expires, its state changes to
expired
and all of the Capacity Reservations in the Fleet expire.The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify
5/31/2019
,13:30:55
, the Capacity Reservation Fleet is guaranteed to expire between13:30:55
and14:30:55
on5/31/2019
.
-
instanceMatchCriteria
Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.
Currently, Capacity Reservation Fleets support
open
instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.If the service returns an enum value that is not available in the current SDK version,
instanceMatchCriteria
will returnFleetInstanceMatchCriteria.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceMatchCriteriaAsString()
.- Returns:
- Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity
Reservations in the Fleet inherit this instance matching criteria.
Currently, Capacity Reservation Fleets support
open
instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity. - See Also:
-
instanceMatchCriteriaAsString
Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.
Currently, Capacity Reservation Fleets support
open
instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.If the service returns an enum value that is not available in the current SDK version,
instanceMatchCriteria
will returnFleetInstanceMatchCriteria.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceMatchCriteriaAsString()
.- Returns:
- Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity
Reservations in the Fleet inherit this instance matching criteria.
Currently, Capacity Reservation Fleets support
open
instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity. - See Also:
-
hasTagSpecifications
public final boolean hasTagSpecifications()For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
tagSpecifications
The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet.
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
hasTagSpecifications()
method.- Returns:
- The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet.
-
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 isUnauthorizedOperation
.- Returns:
- 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 isUnauthorizedOperation
.
-
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 interfaceToCopyableBuilder<CreateCapacityReservationFleetRequest.Builder,
CreateCapacityReservationFleetRequest> - Specified by:
toBuilder
in classEc2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends CreateCapacityReservationFleetRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-