Class CreateCapacityReservationRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateCapacityReservationRequest.Builder,
CreateCapacityReservationRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Availability Zone in which to create the Capacity Reservation.final String
The ID of the Availability Zone in which to create the Capacity Reservation.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 Boolean
Indicates whether the Capacity Reservation supports EBS-optimized instances.final Instant
endDate()
The date and time at which the Capacity Reservation expires.final EndDateType
Indicates the way in which the Capacity Reservation ends.final String
Indicates the way in which the Capacity Reservation ends.final Boolean
Deprecated.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 TagSpecifications property.final Integer
The number of instances for which to reserve capacity.final InstanceMatchCriteria
Indicates the type of instance launches that the Capacity Reservation accepts.final String
Indicates the type of instance launches that the Capacity Reservation accepts.The type of operating system for which to reserve capacity.final String
The type of operating system for which to reserve capacity.final String
The instance type for which to reserve capacity.final String
The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.final String
The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation.static Class
<? extends CreateCapacityReservationRequest.Builder> final List
<TagSpecification> The tags to apply to the Capacity Reservation during launch.tenancy()
Indicates the tenancy of the Capacity Reservation.final String
Indicates the tenancy of the Capacity Reservation.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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
-
instanceType
The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.
- Returns:
- The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.
-
instancePlatform
The type of operating system for which to reserve capacity.
If the service returns an enum value that is not available in the current SDK version,
instancePlatform
will returnCapacityReservationInstancePlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstancePlatformAsString()
.- Returns:
- The type of operating system for which to reserve capacity.
- See Also:
-
instancePlatformAsString
The type of operating system for which to reserve capacity.
If the service returns an enum value that is not available in the current SDK version,
instancePlatform
will returnCapacityReservationInstancePlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstancePlatformAsString()
.- Returns:
- The type of operating system for which to reserve capacity.
- See Also:
-
availabilityZone
The Availability Zone in which to create the Capacity Reservation.
- Returns:
- The Availability Zone in which to create the Capacity Reservation.
-
availabilityZoneId
The ID of the Availability Zone in which to create the Capacity Reservation.
- Returns:
- The ID of the Availability Zone in which to create the Capacity Reservation.
-
tenancy
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
-
default
- The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts. -
dedicated
- The Capacity Reservation is 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 returnCapacityReservationTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtenancyAsString()
.- Returns:
- Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following
tenancy settings:
-
default
- The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts. -
dedicated
- The Capacity Reservation is 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. A Capacity Reservation can have one of the following tenancy settings:
-
default
- The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts. -
dedicated
- The Capacity Reservation is 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 returnCapacityReservationTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtenancyAsString()
.- Returns:
- Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following
tenancy settings:
-
default
- The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts. -
dedicated
- The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
-
- See Also:
-
-
instanceCount
The number of instances for which to reserve capacity.
Valid range: 1 - 1000
- Returns:
- The number of instances for which to reserve capacity.
Valid range: 1 - 1000
-
ebsOptimized
Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
- Returns:
- Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
-
ephemeralStorage
Deprecated.
- Returns:
- Deprecated.
-
endDate
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to
expired
when it reaches its end date and time.You must provide an
EndDate
value ifEndDateType
islimited
. OmitEndDate
ifEndDateType
isunlimited
.If the
EndDateType
islimited
, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.- Returns:
- The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the
reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's
state changes to
expired
when it reaches its end date and time.You must provide an
EndDate
value ifEndDateType
islimited
. OmitEndDate
ifEndDateType
isunlimited
.If the
EndDateType
islimited
, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
-
endDateType
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
-
unlimited
- The Capacity Reservation remains active until you explicitly cancel it. Do not provide anEndDate
if theEndDateType
isunlimited
. -
limited
- The Capacity Reservation expires automatically at a specified date and time. You must provide anEndDate
value if theEndDateType
value islimited
.
If the service returns an enum value that is not available in the current SDK version,
endDateType
will returnEndDateType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendDateTypeAsString()
.- Returns:
- Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the
following end types:
-
unlimited
- The Capacity Reservation remains active until you explicitly cancel it. Do not provide anEndDate
if theEndDateType
isunlimited
. -
limited
- The Capacity Reservation expires automatically at a specified date and time. You must provide anEndDate
value if theEndDateType
value islimited
.
-
- See Also:
-
-
endDateTypeAsString
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
-
unlimited
- The Capacity Reservation remains active until you explicitly cancel it. Do not provide anEndDate
if theEndDateType
isunlimited
. -
limited
- The Capacity Reservation expires automatically at a specified date and time. You must provide anEndDate
value if theEndDateType
value islimited
.
If the service returns an enum value that is not available in the current SDK version,
endDateType
will returnEndDateType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendDateTypeAsString()
.- Returns:
- Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the
following end types:
-
unlimited
- The Capacity Reservation remains active until you explicitly cancel it. Do not provide anEndDate
if theEndDateType
isunlimited
. -
limited
- The Capacity Reservation expires automatically at a specified date and time. You must provide anEndDate
value if theEndDateType
value islimited
.
-
- See Also:
-
-
instanceMatchCriteria
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
-
open
- The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters. -
targeted
- The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Default:
open
If the service returns an enum value that is not available in the current SDK version,
instanceMatchCriteria
will returnInstanceMatchCriteria.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 accepts. The options include:
-
open
- The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters. -
targeted
- The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Default:
open
-
- See Also:
-
-
instanceMatchCriteriaAsString
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
-
open
- The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters. -
targeted
- The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Default:
open
If the service returns an enum value that is not available in the current SDK version,
instanceMatchCriteria
will returnInstanceMatchCriteria.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 accepts. The options include:
-
open
- The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters. -
targeted
- The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Default:
open
-
- 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 apply to the Capacity Reservation during launch.
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 apply to the Capacity Reservation during launch.
-
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
.
-
outpostArn
The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
- Returns:
- The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
-
placementGroupArn
The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.
- Returns:
- The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.
-
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<CreateCapacityReservationRequest.Builder,
CreateCapacityReservationRequest> - Specified by:
toBuilder
in classEc2Request
- Returns:
- a builder for type T
-
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
-