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

Class CreateCapacityReservationRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateCapacityReservationRequest.Builder,CreateCapacityReservationRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateCapacityReservationRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	availabilityZone()	The Availability Zone in which to create the Capacity Reservation.
String	availabilityZoneId()	The ID of the Availability Zone in which to create the Capacity Reservation.
static CreateCapacityReservationRequest.Builder	builder()
String	clientToken()	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Long	commitmentDuration()
CapacityReservationDeliveryPreference	deliveryPreference()
String	deliveryPreferenceAsString()
Boolean	dryRun()	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
Boolean	ebsOptimized()	Indicates whether the Capacity Reservation supports EBS-optimized instances.
Instant	endDate()	The date and time at which the Capacity Reservation expires.
EndDateType	endDateType()	Indicates the way in which the Capacity Reservation ends.
String	endDateTypeAsString()	Indicates the way in which the Capacity Reservation ends.
Boolean	ephemeralStorage()	Deprecated.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTagSpecifications()	For responses, this returns true if the service returned a value for the TagSpecifications property.
Integer	instanceCount()	The number of instances for which to reserve capacity.
InstanceMatchCriteria	instanceMatchCriteria()	Indicates the type of instance launches that the Capacity Reservation accepts.
String	instanceMatchCriteriaAsString()	Indicates the type of instance launches that the Capacity Reservation accepts.
CapacityReservationInstancePlatform	instancePlatform()	The type of operating system for which to reserve capacity.
String	instancePlatformAsString()	The type of operating system for which to reserve capacity.
String	instanceType()	The instance type for which to reserve capacity.
String	outpostArn()
String	placementGroupArn()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateCapacityReservationRequest.Builder>	serializableBuilderClass()
Instant	startDate()
List<TagSpecification>	tagSpecifications()	The tags to apply to the Capacity Reservation during launch.
CapacityReservationTenancy	tenancy()	Indicates the tenancy of the Capacity Reservation.
String	tenancyAsString()	Indicates the tenancy of the Capacity Reservation.
CreateCapacityReservationRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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 final String 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

public final String instanceType()

The instance type for which to reserve capacity.

You can request future-dated Capacity Reservations for instance types in the C, M, R, I, and T instance families only.

For more information, see Instance types in the Amazon EC2 User Guide.

Returns:

The instance type for which to reserve capacity.

You can request future-dated Capacity Reservations for instance types in the C, M, R, I, and T instance families only.

For more information, see Instance types in the Amazon EC2 User Guide.

instancePlatform

public final CapacityReservationInstancePlatform 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 return CapacityReservationInstancePlatform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instancePlatformAsString().

Returns:

The type of operating system for which to reserve capacity.

See Also:

CapacityReservationInstancePlatform

instancePlatformAsString

public final String 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 return CapacityReservationInstancePlatform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instancePlatformAsString().

Returns:

The type of operating system for which to reserve capacity.

See Also:

CapacityReservationInstancePlatform

availabilityZone

public final String availabilityZone()

The Availability Zone in which to create the Capacity Reservation.

Returns:

The Availability Zone in which to create the Capacity Reservation.

availabilityZoneId

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

public final CapacityReservationTenancy 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 return CapacityReservationTenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tenancyAsString().

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:

CapacityReservationTenancy

tenancyAsString

public final String 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 return CapacityReservationTenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tenancyAsString().

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:

CapacityReservationTenancy

instanceCount

public final Integer instanceCount()

The number of instances for which to reserve capacity.

You can request future-dated Capacity Reservations for an instance count with a minimum of 100 VPUs. For example, if you request a future-dated Capacity Reservation for m5.xlarge instances, you must request at least 25 instances (25 * m5.xlarge = 100 vCPUs).

Valid range: 1 - 1000

Returns:

The number of instances for which to reserve capacity.

You can request future-dated Capacity Reservations for an instance count with a minimum of 100 VPUs. For example, if you request a future-dated Capacity Reservation for m5.xlarge instances, you must request at least 25 instances (25 * m5.xlarge = 100 vCPUs).

Valid range: 1 - 1000

ebsOptimized

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

public final Boolean ephemeralStorage()

Deprecated.

Returns:

Deprecated.

endDate

public final Instant 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 if EndDateType is limited. Omit EndDate if EndDateType is unlimited.

If the EndDateType is limited, 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.

If you are requesting a future-dated Capacity Reservation, you can't specify an end date and time that is within the commitment duration.

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 if EndDateType is limited. Omit EndDate if EndDateType is unlimited.

If the EndDateType is limited, 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.

If you are requesting a future-dated Capacity Reservation, you can't specify an end date and time that is within the commitment duration.

endDateType

public final EndDateType 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 an EndDate if the EndDateType is unlimited.

• limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.

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

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 an EndDate if the EndDateType is unlimited.

• limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.

See Also:

EndDateType

endDateTypeAsString

public final String 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 an EndDate if the EndDateType is unlimited.

• limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.

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

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 an EndDate if the EndDateType is unlimited.

• limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.

See Also:

EndDateType

instanceMatchCriteria

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

If you are requesting a future-dated Capacity Reservation, you must specify targeted.

Default: open

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

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.

If you are requesting a future-dated Capacity Reservation, you must specify targeted.

Default: open

See Also:

InstanceMatchCriteria

instanceMatchCriteriaAsString

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

If you are requesting a future-dated Capacity Reservation, you must specify targeted.

Default: open

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

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.

If you are requesting a future-dated Capacity Reservation, you must specify targeted.

Default: open

See Also:

InstanceMatchCriteria

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

tagSpecifications

public final List<TagSpecification> 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

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

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 is UnauthorizedOperation.

outpostArn

public final String outpostArn()

Not supported for future-dated Capacity Reservations.

The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.

Returns:

Not supported for future-dated Capacity Reservations.

The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.

placementGroupArn

public final String placementGroupArn()

Not supported for future-dated Capacity Reservations.

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:

Not supported for future-dated Capacity Reservations.

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.

startDate

public final Instant startDate()

Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

The date and time at which the future-dated Capacity Reservation should become available for use, in the ISO8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).

You can request a future-dated Capacity Reservation between 5 and 120 days in advance.

Returns:

Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

The date and time at which the future-dated Capacity Reservation should become available for use, in the ISO8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).

You can request a future-dated Capacity Reservation between 5 and 120 days in advance.

commitmentDuration

public final Long commitmentDuration()

Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

Specify a commitment duration, in seconds, for the future-dated Capacity Reservation.

The commitment duration is a minimum duration for which you commit to having the future-dated Capacity Reservation in the active state in your account after it has been delivered.

For more information, see Commitment duration.

Returns:

Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

Specify a commitment duration, in seconds, for the future-dated Capacity Reservation.

The commitment duration is a minimum duration for which you commit to having the future-dated Capacity Reservation in the active state in your account after it has been delivered.

For more information, see Commitment duration.

deliveryPreference

public final CapacityReservationDeliveryPreference deliveryPreference()

Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

Indicates that the requested capacity will be delivered in addition to any running instances or reserved capacity that you have in your account at the requested date and time.

The only supported value is incremental.

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

Returns:

Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

Indicates that the requested capacity will be delivered in addition to any running instances or reserved capacity that you have in your account at the requested date and time.

The only supported value is incremental.

See Also:

CapacityReservationDeliveryPreference

deliveryPreferenceAsString

public final String deliveryPreferenceAsString()

Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

Indicates that the requested capacity will be delivered in addition to any running instances or reserved capacity that you have in your account at the requested date and time.

The only supported value is incremental.

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

Returns:

Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

Indicates that the requested capacity will be delivered in addition to any running instances or reserved capacity that you have in your account at the requested date and time.

The only supported value is incremental.

See Also:

CapacityReservationDeliveryPreference

toBuilder

public CreateCapacityReservationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCapacityReservationRequest.Builder,CreateCapacityReservationRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static CreateCapacityReservationRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo