software.amazon.awssdk.services.ec2.model

Interface CreateCapacityReservationRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateCapacityReservationRequest.Builder,CreateCapacityReservationRequest>, Ec2Request.Builder, SdkBuilder<CreateCapacityReservationRequest.Builder,CreateCapacityReservationRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateCapacityReservationRequest

public static interface CreateCapacityReservationRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateCapacityReservationRequest.Builder,CreateCapacityReservationRequest>

Method Summary

Modifier and Type	Method and Description
CreateCapacityReservationRequest.Builder	availabilityZone(String availabilityZone) The Availability Zone in which to create the Capacity Reservation.
CreateCapacityReservationRequest.Builder	availabilityZoneId(String availabilityZoneId) The ID of the Availability Zone in which to create the Capacity Reservation.
CreateCapacityReservationRequest.Builder	clientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateCapacityReservationRequest.Builder	ebsOptimized(Boolean ebsOptimized) Indicates whether the Capacity Reservation supports EBS-optimized instances.
CreateCapacityReservationRequest.Builder	endDate(Instant endDate) The date and time at which the Capacity Reservation expires.
CreateCapacityReservationRequest.Builder	endDateType(EndDateType endDateType) Indicates the way in which the Capacity Reservation ends.
CreateCapacityReservationRequest.Builder	endDateType(String endDateType) Indicates the way in which the Capacity Reservation ends.
CreateCapacityReservationRequest.Builder	ephemeralStorage(Boolean ephemeralStorage) Deprecated.
CreateCapacityReservationRequest.Builder	instanceCount(Integer instanceCount) The number of instances for which to reserve capacity.
CreateCapacityReservationRequest.Builder	instanceMatchCriteria(InstanceMatchCriteria instanceMatchCriteria) Indicates the type of instance launches that the Capacity Reservation accepts.
CreateCapacityReservationRequest.Builder	instanceMatchCriteria(String instanceMatchCriteria) Indicates the type of instance launches that the Capacity Reservation accepts.
CreateCapacityReservationRequest.Builder	instancePlatform(CapacityReservationInstancePlatform instancePlatform) The type of operating system for which to reserve capacity.
CreateCapacityReservationRequest.Builder	instancePlatform(String instancePlatform) The type of operating system for which to reserve capacity.
CreateCapacityReservationRequest.Builder	instanceType(String instanceType) The instance type for which to reserve capacity.
CreateCapacityReservationRequest.Builder	outpostArn(String outpostArn) The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
CreateCapacityReservationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateCapacityReservationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateCapacityReservationRequest.Builder	placementGroupArn(String placementGroupArn) The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation.
CreateCapacityReservationRequest.Builder	tagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the Capacity Reservation during launch.
CreateCapacityReservationRequest.Builder	tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications) The tags to apply to the Capacity Reservation during launch.
CreateCapacityReservationRequest.Builder	tagSpecifications(TagSpecification... tagSpecifications) The tags to apply to the Capacity Reservation during launch.
CreateCapacityReservationRequest.Builder	tenancy(CapacityReservationTenancy tenancy) Indicates the tenancy of the Capacity Reservation.
CreateCapacityReservationRequest.Builder	tenancy(String tenancy) Indicates the tenancy of the Capacity Reservation.

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

clientToken

CreateCapacityReservationRequest.Builder clientToken(String clientToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceType

CreateCapacityReservationRequest.Builder instanceType(String instanceType)

The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.

Parameters:

instanceType - The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

instancePlatform

CreateCapacityReservationRequest.Builder instancePlatform(String instancePlatform)

The type of operating system for which to reserve capacity.

Parameters:

instancePlatform - The type of operating system for which to reserve capacity.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CapacityReservationInstancePlatform, CapacityReservationInstancePlatform

instancePlatform

CreateCapacityReservationRequest.Builder instancePlatform(CapacityReservationInstancePlatform instancePlatform)

The type of operating system for which to reserve capacity.

Parameters:

instancePlatform - The type of operating system for which to reserve capacity.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CapacityReservationInstancePlatform, CapacityReservationInstancePlatform

availabilityZone

CreateCapacityReservationRequest.Builder availabilityZone(String availabilityZone)

The Availability Zone in which to create the Capacity Reservation.

Parameters:

availabilityZone - The Availability Zone in which to create the Capacity Reservation.

Returns:

Returns a reference to this object so that method calls can be chained together.

availabilityZoneId

CreateCapacityReservationRequest.Builder availabilityZoneId(String availabilityZoneId)

The ID of the Availability Zone in which to create the Capacity Reservation.

Parameters:

availabilityZoneId - The ID of the Availability Zone in which to create the Capacity Reservation.

Returns:

Returns a reference to this object so that method calls can be chained together.

tenancy

CreateCapacityReservationRequest.Builder tenancy(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CapacityReservationTenancy, CapacityReservationTenancy

tenancy

CreateCapacityReservationRequest.Builder tenancy(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CapacityReservationTenancy, CapacityReservationTenancy

instanceCount

CreateCapacityReservationRequest.Builder instanceCount(Integer instanceCount)

The number of instances for which to reserve capacity.

Valid range: 1 - 1000

Parameters:

instanceCount - The number of instances for which to reserve capacity.

Valid range: 1 - 1000

Returns:

Returns a reference to this object so that method calls can be chained together.

ebsOptimized

CreateCapacityReservationRequest.Builder ebsOptimized(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

ephemeralStorage

CreateCapacityReservationRequest.Builder ephemeralStorage(Boolean ephemeralStorage)

Deprecated.

Parameters:

ephemeralStorage - Deprecated.

Returns:

Returns a reference to this object so that method calls can be chained together.

endDate

CreateCapacityReservationRequest.Builder endDate(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

endDateType

CreateCapacityReservationRequest.Builder endDateType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EndDateType, EndDateType

endDateType

CreateCapacityReservationRequest.Builder endDateType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EndDateType, EndDateType

instanceMatchCriteria

CreateCapacityReservationRequest.Builder instanceMatchCriteria(String 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InstanceMatchCriteria, InstanceMatchCriteria

instanceMatchCriteria

CreateCapacityReservationRequest.Builder instanceMatchCriteria(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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InstanceMatchCriteria, InstanceMatchCriteria

tagSpecifications

CreateCapacityReservationRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the Capacity Reservation during launch.

Parameters:

tagSpecifications - The tags to apply to the Capacity Reservation during launch.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagSpecifications

CreateCapacityReservationRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

The tags to apply to the Capacity Reservation during launch.

Parameters:

tagSpecifications - The tags to apply to the Capacity Reservation during launch.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagSpecifications

CreateCapacityReservationRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

The tags to apply to the Capacity Reservation during launch.

This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tagSpecifications(List).

Parameters:

tagSpecifications - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tagSpecifications(List)

outpostArn

CreateCapacityReservationRequest.Builder outpostArn(String outpostArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

placementGroupArn

CreateCapacityReservationRequest.Builder placementGroupArn(String 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateCapacityReservationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateCapacityReservationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder