Interface DescribeSpotInstanceRequestsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeSpotInstanceRequestsRequest.Builder,DescribeSpotInstanceRequestsRequest>
,Ec2Request.Builder
,SdkBuilder<DescribeSpotInstanceRequestsRequest.Builder,DescribeSpotInstanceRequestsRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- DescribeSpotInstanceRequestsRequest
public static interface DescribeSpotInstanceRequestsRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeSpotInstanceRequestsRequest.Builder,DescribeSpotInstanceRequestsRequest>
-
-
Method Summary
-
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 Detail
-
filters
DescribeSpotInstanceRequestsRequest.Builder filters(Collection<Filter> filters)
The filters.
-
availability-zone-group
- The Availability Zone group. -
create-time
- The time stamp when the Spot Instance request was created. -
fault-code
- The fault code related to the request. -
fault-message
- The fault message related to the request. -
instance-id
- The ID of the instance that fulfilled the request. -
launch-group
- The Spot Instance launch group. -
launch.block-device-mapping.delete-on-termination
- Indicates whether the EBS volume is deleted on instance termination. -
launch.block-device-mapping.device-name
- The device name for the volume in the block device mapping (for example,/dev/sdh
orxvdh
). -
launch.block-device-mapping.snapshot-id
- The ID of the snapshot for the EBS volume. -
launch.block-device-mapping.volume-size
- The size of the EBS volume, in GiB. -
launch.block-device-mapping.volume-type
- The type of EBS volume:gp2
orgp3
for General Purpose SSD,io1
orio2
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic. -
launch.group-id
- The ID of the security group for the instance. -
launch.group-name
- The name of the security group for the instance. -
launch.image-id
- The ID of the AMI. -
launch.instance-type
- The type of instance (for example,m3.medium
). -
launch.kernel-id
- The kernel ID. -
launch.key-name
- The name of the key pair the instance launched with. -
launch.monitoring-enabled
- Whether detailed monitoring is enabled for the Spot Instance. -
launch.ramdisk-id
- The RAM disk ID. -
launched-availability-zone
- The Availability Zone in which the request is launched. -
network-interface.addresses.primary
- Indicates whether the IP address is the primary private IP address. -
network-interface.delete-on-termination
- Indicates whether the network interface is deleted when the instance is terminated. -
network-interface.description
- A description of the network interface. -
network-interface.device-index
- The index of the device for the network interface attachment on the instance. -
network-interface.group-id
- The ID of the security group associated with the network interface. -
network-interface.network-interface-id
- The ID of the network interface. -
network-interface.private-ip-address
- The primary private IP address of the network interface. -
network-interface.subnet-id
- The ID of the subnet for the instance. -
product-description
- The product description associated with the instance (Linux/UNIX
|Windows
). -
spot-instance-request-id
- The Spot Instance request ID. -
spot-price
- The maximum hourly price for any Spot Instance launched to fulfill the request. -
state
- The state of the Spot Instance request (open
|active
|closed
|cancelled
|failed
). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances. -
status-code
- The short code describing the most recent evaluation of your Spot Instance request. -
status-message
- The message explaining the status of the Spot Instance request. -
tag:<key>
- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
type
- The type of Spot Instance request (one-time
|persistent
). -
valid-from
- The start date of the request. -
valid-until
- The end date of the request.
- Parameters:
filters
- The filters.-
availability-zone-group
- The Availability Zone group. -
create-time
- The time stamp when the Spot Instance request was created. -
fault-code
- The fault code related to the request. -
fault-message
- The fault message related to the request. -
instance-id
- The ID of the instance that fulfilled the request. -
launch-group
- The Spot Instance launch group. -
launch.block-device-mapping.delete-on-termination
- Indicates whether the EBS volume is deleted on instance termination. -
launch.block-device-mapping.device-name
- The device name for the volume in the block device mapping (for example,/dev/sdh
orxvdh
). -
launch.block-device-mapping.snapshot-id
- The ID of the snapshot for the EBS volume. -
launch.block-device-mapping.volume-size
- The size of the EBS volume, in GiB. -
launch.block-device-mapping.volume-type
- The type of EBS volume:gp2
orgp3
for General Purpose SSD,io1
orio2
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic. -
launch.group-id
- The ID of the security group for the instance. -
launch.group-name
- The name of the security group for the instance. -
launch.image-id
- The ID of the AMI. -
launch.instance-type
- The type of instance (for example,m3.medium
). -
launch.kernel-id
- The kernel ID. -
launch.key-name
- The name of the key pair the instance launched with. -
launch.monitoring-enabled
- Whether detailed monitoring is enabled for the Spot Instance. -
launch.ramdisk-id
- The RAM disk ID. -
launched-availability-zone
- The Availability Zone in which the request is launched. -
network-interface.addresses.primary
- Indicates whether the IP address is the primary private IP address. -
network-interface.delete-on-termination
- Indicates whether the network interface is deleted when the instance is terminated. -
network-interface.description
- A description of the network interface. -
network-interface.device-index
- The index of the device for the network interface attachment on the instance. -
network-interface.group-id
- The ID of the security group associated with the network interface. -
network-interface.network-interface-id
- The ID of the network interface. -
network-interface.private-ip-address
- The primary private IP address of the network interface. -
network-interface.subnet-id
- The ID of the subnet for the instance. -
product-description
- The product description associated with the instance (Linux/UNIX
|Windows
). -
spot-instance-request-id
- The Spot Instance request ID. -
spot-price
- The maximum hourly price for any Spot Instance launched to fulfill the request. -
state
- The state of the Spot Instance request (open
|active
|closed
|cancelled
|failed
). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances. -
status-code
- The short code describing the most recent evaluation of your Spot Instance request. -
status-message
- The message explaining the status of the Spot Instance request. -
tag:<key>
- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
type
- The type of Spot Instance request (one-time
|persistent
). -
valid-from
- The start date of the request. -
valid-until
- The end date of the request.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
DescribeSpotInstanceRequestsRequest.Builder filters(Filter... filters)
The filters.
-
availability-zone-group
- The Availability Zone group. -
create-time
- The time stamp when the Spot Instance request was created. -
fault-code
- The fault code related to the request. -
fault-message
- The fault message related to the request. -
instance-id
- The ID of the instance that fulfilled the request. -
launch-group
- The Spot Instance launch group. -
launch.block-device-mapping.delete-on-termination
- Indicates whether the EBS volume is deleted on instance termination. -
launch.block-device-mapping.device-name
- The device name for the volume in the block device mapping (for example,/dev/sdh
orxvdh
). -
launch.block-device-mapping.snapshot-id
- The ID of the snapshot for the EBS volume. -
launch.block-device-mapping.volume-size
- The size of the EBS volume, in GiB. -
launch.block-device-mapping.volume-type
- The type of EBS volume:gp2
orgp3
for General Purpose SSD,io1
orio2
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic. -
launch.group-id
- The ID of the security group for the instance. -
launch.group-name
- The name of the security group for the instance. -
launch.image-id
- The ID of the AMI. -
launch.instance-type
- The type of instance (for example,m3.medium
). -
launch.kernel-id
- The kernel ID. -
launch.key-name
- The name of the key pair the instance launched with. -
launch.monitoring-enabled
- Whether detailed monitoring is enabled for the Spot Instance. -
launch.ramdisk-id
- The RAM disk ID. -
launched-availability-zone
- The Availability Zone in which the request is launched. -
network-interface.addresses.primary
- Indicates whether the IP address is the primary private IP address. -
network-interface.delete-on-termination
- Indicates whether the network interface is deleted when the instance is terminated. -
network-interface.description
- A description of the network interface. -
network-interface.device-index
- The index of the device for the network interface attachment on the instance. -
network-interface.group-id
- The ID of the security group associated with the network interface. -
network-interface.network-interface-id
- The ID of the network interface. -
network-interface.private-ip-address
- The primary private IP address of the network interface. -
network-interface.subnet-id
- The ID of the subnet for the instance. -
product-description
- The product description associated with the instance (Linux/UNIX
|Windows
). -
spot-instance-request-id
- The Spot Instance request ID. -
spot-price
- The maximum hourly price for any Spot Instance launched to fulfill the request. -
state
- The state of the Spot Instance request (open
|active
|closed
|cancelled
|failed
). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances. -
status-code
- The short code describing the most recent evaluation of your Spot Instance request. -
status-message
- The message explaining the status of the Spot Instance request. -
tag:<key>
- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
type
- The type of Spot Instance request (one-time
|persistent
). -
valid-from
- The start date of the request. -
valid-until
- The end date of the request.
- Parameters:
filters
- The filters.-
availability-zone-group
- The Availability Zone group. -
create-time
- The time stamp when the Spot Instance request was created. -
fault-code
- The fault code related to the request. -
fault-message
- The fault message related to the request. -
instance-id
- The ID of the instance that fulfilled the request. -
launch-group
- The Spot Instance launch group. -
launch.block-device-mapping.delete-on-termination
- Indicates whether the EBS volume is deleted on instance termination. -
launch.block-device-mapping.device-name
- The device name for the volume in the block device mapping (for example,/dev/sdh
orxvdh
). -
launch.block-device-mapping.snapshot-id
- The ID of the snapshot for the EBS volume. -
launch.block-device-mapping.volume-size
- The size of the EBS volume, in GiB. -
launch.block-device-mapping.volume-type
- The type of EBS volume:gp2
orgp3
for General Purpose SSD,io1
orio2
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic. -
launch.group-id
- The ID of the security group for the instance. -
launch.group-name
- The name of the security group for the instance. -
launch.image-id
- The ID of the AMI. -
launch.instance-type
- The type of instance (for example,m3.medium
). -
launch.kernel-id
- The kernel ID. -
launch.key-name
- The name of the key pair the instance launched with. -
launch.monitoring-enabled
- Whether detailed monitoring is enabled for the Spot Instance. -
launch.ramdisk-id
- The RAM disk ID. -
launched-availability-zone
- The Availability Zone in which the request is launched. -
network-interface.addresses.primary
- Indicates whether the IP address is the primary private IP address. -
network-interface.delete-on-termination
- Indicates whether the network interface is deleted when the instance is terminated. -
network-interface.description
- A description of the network interface. -
network-interface.device-index
- The index of the device for the network interface attachment on the instance. -
network-interface.group-id
- The ID of the security group associated with the network interface. -
network-interface.network-interface-id
- The ID of the network interface. -
network-interface.private-ip-address
- The primary private IP address of the network interface. -
network-interface.subnet-id
- The ID of the subnet for the instance. -
product-description
- The product description associated with the instance (Linux/UNIX
|Windows
). -
spot-instance-request-id
- The Spot Instance request ID. -
spot-price
- The maximum hourly price for any Spot Instance launched to fulfill the request. -
state
- The state of the Spot Instance request (open
|active
|closed
|cancelled
|failed
). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances. -
status-code
- The short code describing the most recent evaluation of your Spot Instance request. -
status-message
- The message explaining the status of the Spot Instance request. -
tag:<key>
- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
type
- The type of Spot Instance request (one-time
|persistent
). -
valid-from
- The start date of the request. -
valid-until
- The end date of the request.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
DescribeSpotInstanceRequestsRequest.Builder filters(Consumer<Filter.Builder>... filters)
The filters.
-
availability-zone-group
- The Availability Zone group. -
create-time
- The time stamp when the Spot Instance request was created. -
fault-code
- The fault code related to the request. -
fault-message
- The fault message related to the request. -
instance-id
- The ID of the instance that fulfilled the request. -
launch-group
- The Spot Instance launch group. -
launch.block-device-mapping.delete-on-termination
- Indicates whether the EBS volume is deleted on instance termination. -
launch.block-device-mapping.device-name
- The device name for the volume in the block device mapping (for example,/dev/sdh
orxvdh
). -
launch.block-device-mapping.snapshot-id
- The ID of the snapshot for the EBS volume. -
launch.block-device-mapping.volume-size
- The size of the EBS volume, in GiB. -
launch.block-device-mapping.volume-type
- The type of EBS volume:gp2
orgp3
for General Purpose SSD,io1
orio2
for Provisioned IOPS SSD,st1
for Throughput Optimized HDD,sc1
for Cold HDD, orstandard
for Magnetic. -
launch.group-id
- The ID of the security group for the instance. -
launch.group-name
- The name of the security group for the instance. -
launch.image-id
- The ID of the AMI. -
launch.instance-type
- The type of instance (for example,m3.medium
). -
launch.kernel-id
- The kernel ID. -
launch.key-name
- The name of the key pair the instance launched with. -
launch.monitoring-enabled
- Whether detailed monitoring is enabled for the Spot Instance. -
launch.ramdisk-id
- The RAM disk ID. -
launched-availability-zone
- The Availability Zone in which the request is launched. -
network-interface.addresses.primary
- Indicates whether the IP address is the primary private IP address. -
network-interface.delete-on-termination
- Indicates whether the network interface is deleted when the instance is terminated. -
network-interface.description
- A description of the network interface. -
network-interface.device-index
- The index of the device for the network interface attachment on the instance. -
network-interface.group-id
- The ID of the security group associated with the network interface. -
network-interface.network-interface-id
- The ID of the network interface. -
network-interface.private-ip-address
- The primary private IP address of the network interface. -
network-interface.subnet-id
- The ID of the subnet for the instance. -
product-description
- The product description associated with the instance (Linux/UNIX
|Windows
). -
spot-instance-request-id
- The Spot Instance request ID. -
spot-price
- The maximum hourly price for any Spot Instance launched to fulfill the request. -
state
- The state of the Spot Instance request (open
|active
|closed
|cancelled
|failed
). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances. -
status-code
- The short code describing the most recent evaluation of your Spot Instance request. -
status-message
- The message explaining the status of the Spot Instance request. -
tag:<key>
- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
type
- The type of Spot Instance request (one-time
|persistent
). -
valid-from
- The start date of the request. -
valid-until
- The end date of the request.
Filter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#filters(List
.) - Parameters:
filters
- a consumer that will call methods onFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#filters(java.util.Collection
)
-
-
dryRun
DescribeSpotInstanceRequestsRequest.Builder dryRun(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 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.
-
spotInstanceRequestIds
DescribeSpotInstanceRequestsRequest.Builder spotInstanceRequestIds(Collection<String> spotInstanceRequestIds)
The IDs of the Spot Instance requests.
- Parameters:
spotInstanceRequestIds
- The IDs of the Spot Instance requests.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
spotInstanceRequestIds
DescribeSpotInstanceRequestsRequest.Builder spotInstanceRequestIds(String... spotInstanceRequestIds)
The IDs of the Spot Instance requests.
- Parameters:
spotInstanceRequestIds
- The IDs of the Spot Instance requests.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
DescribeSpotInstanceRequestsRequest.Builder nextToken(String nextToken)
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- Parameters:
nextToken
- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
DescribeSpotInstanceRequestsRequest.Builder maxResults(Integer maxResults)
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
- Parameters:
maxResults
- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeSpotInstanceRequestsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
DescribeSpotInstanceRequestsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-