Interface CreateCapacityReservationRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateCapacityReservationRequest.Builder,
,CreateCapacityReservationRequest> Ec2Request.Builder
,SdkBuilder<CreateCapacityReservationRequest.Builder,
,CreateCapacityReservationRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateCapacityReservationRequest
-
Method Summary
Modifier and TypeMethodDescriptionavailabilityZone
(String availabilityZone) The Availability Zone in which to create the Capacity Reservation.availabilityZoneId
(String availabilityZoneId) The ID of the Availability Zone in which to create the Capacity Reservation.clientToken
(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.ebsOptimized
(Boolean ebsOptimized) Indicates whether the Capacity Reservation supports EBS-optimized instances.The date and time at which the Capacity Reservation expires.endDateType
(String endDateType) Indicates the way in which the Capacity Reservation ends.endDateType
(EndDateType endDateType) Indicates the way in which the Capacity Reservation ends.ephemeralStorage
(Boolean ephemeralStorage) Deprecated.instanceCount
(Integer instanceCount) The number of instances for which to reserve capacity.instanceMatchCriteria
(String instanceMatchCriteria) Indicates the type of instance launches that the Capacity Reservation accepts.instanceMatchCriteria
(InstanceMatchCriteria instanceMatchCriteria) Indicates the type of instance launches that the Capacity Reservation accepts.instancePlatform
(String instancePlatform) The type of operating system for which to reserve capacity.instancePlatform
(CapacityReservationInstancePlatform instancePlatform) The type of operating system for which to reserve capacity.instanceType
(String instanceType) The instance type for which to reserve capacity.outpostArn
(String outpostArn) The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.placementGroupArn
(String placementGroupArn) The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation.tagSpecifications
(Collection<TagSpecification> tagSpecifications) The tags to apply to the Capacity Reservation during launch.tagSpecifications
(Consumer<TagSpecification.Builder>... tagSpecifications) The tags to apply to the Capacity Reservation during launch.tagSpecifications
(TagSpecification... tagSpecifications) The tags to apply to the Capacity Reservation during launch.Indicates the tenancy of the Capacity Reservation.tenancy
(CapacityReservationTenancy tenancy) Indicates the tenancy of the Capacity Reservation.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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:
-
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:
-
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
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
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:
-
-
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:
-
-
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
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
Deprecated.
- Parameters:
ephemeralStorage
- Deprecated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- 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 toexpired
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:
- Returns a reference to this object so that method calls can be chained together.
-
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
.
- 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 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
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
.
- 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 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
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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
- 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
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:
-
-
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
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 theTagSpecification.Builder
avoiding the need to create one manually viaTagSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totagSpecifications(List<TagSpecification>)
.- Parameters:
tagSpecifications
- a consumer that will call methods onTagSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
.- Parameters:
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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateCapacityReservationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-