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(value="software.amazon.awssdk:codegen")
public final class CreateCapacityReservationRequest
extends Ec2Request
implements ToCopyableBuilder<CreateCapacityReservationRequest.Builder,CreateCapacityReservationRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateCapacityReservationRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	availabilityZone() 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.
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() Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
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.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateCapacityReservationRequest.Builder>	serializableBuilderClass()
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

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 that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Constraint: Maximum 64 ASCII characters.

Returns:

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

Constraint: Maximum 64 ASCII characters.

instanceType

public String instanceType()

The instance type for which to reserve capacity. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Returns:

The instance type for which to reserve capacity. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

instancePlatform

public 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 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 String availabilityZone()

The Availability Zone in which to create the Capacity Reservation.

Returns:

The Availability Zone in which to create the Capacity Reservation.

tenancy

public 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 AWS accounts.

• dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS 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 AWS accounts.

• dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

See Also:

CapacityReservationTenancy

tenancyAsString

public 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 AWS accounts.

• dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS 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 AWS accounts.

• dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

See Also:

CapacityReservationTenancy

instanceCount

public Integer instanceCount()

The number of instances for which to reserve capacity.

Returns:

The number of instances for which to reserve capacity.

ebsOptimized

public 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 Boolean ephemeralStorage()

Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.

Returns:

Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.

endDate

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

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.

endDateType

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

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.

Default: open

See Also:

InstanceMatchCriteria

instanceMatchCriteriaAsString

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

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.

Default: open

See Also:

InstanceMatchCriteria

tagSpecifications

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

Returns:

The tags to apply to the Capacity Reservation during launch.

toBuilder

public CreateCapacityReservationRequest.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<CreateCapacityReservationRequest.Builder,CreateCapacityReservationRequest>

Specified by:

toBuilder in class Ec2Request

Returns:

a builder for type T

builder

public static CreateCapacityReservationRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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

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