Interface DescribeHostsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeHostsRequest.Builder,
,DescribeHostsRequest> Ec2Request.Builder
,SdkBuilder<DescribeHostsRequest.Builder,
,DescribeHostsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeHostsRequest
-
Method Summary
Modifier and TypeMethodDescriptionfilter
(Collection<Filter> filter) The filters.filter
(Consumer<Filter.Builder>... filter) The filters.The filters.The IDs of the Dedicated Hosts.hostIds
(Collection<String> hostIds) The IDs of the Dedicated Hosts.maxResults
(Integer maxResults) The maximum number of results to return for the request in a single page.The token to use to retrieve the next page of results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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
-
filter
The filters.
-
auto-placement
- Whether auto-placement is enabled or disabled (on
|off
). -
availability-zone
- The Availability Zone of the host. -
client-token
- The idempotency token that you provided when you allocated the host. -
host-reservation-id
- The ID of the reservation assigned to this host. -
instance-type
- The instance type size that the Dedicated Host is configured to support. -
state
- The allocation state of the Dedicated Host (available
|under-assessment
|permanent-failure
|released
|released-permanent-failure
). -
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.
- Parameters:
filter
- The filters.-
auto-placement
- Whether auto-placement is enabled or disabled (on
|off
). -
availability-zone
- The Availability Zone of the host. -
client-token
- The idempotency token that you provided when you allocated the host. -
host-reservation-id
- The ID of the reservation assigned to this host. -
instance-type
- The instance type size that the Dedicated Host is configured to support. -
state
- The allocation state of the Dedicated Host (available
|under-assessment
|permanent-failure
|released
|released-permanent-failure
). -
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filter
The filters.
-
auto-placement
- Whether auto-placement is enabled or disabled (on
|off
). -
availability-zone
- The Availability Zone of the host. -
client-token
- The idempotency token that you provided when you allocated the host. -
host-reservation-id
- The ID of the reservation assigned to this host. -
instance-type
- The instance type size that the Dedicated Host is configured to support. -
state
- The allocation state of the Dedicated Host (available
|under-assessment
|permanent-failure
|released
|released-permanent-failure
). -
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.
- Parameters:
filter
- The filters.-
auto-placement
- Whether auto-placement is enabled or disabled (on
|off
). -
availability-zone
- The Availability Zone of the host. -
client-token
- The idempotency token that you provided when you allocated the host. -
host-reservation-id
- The ID of the reservation assigned to this host. -
instance-type
- The instance type size that the Dedicated Host is configured to support. -
state
- The allocation state of the Dedicated Host (available
|under-assessment
|permanent-failure
|released
|released-permanent-failure
). -
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filter
The filters.
-
auto-placement
- Whether auto-placement is enabled or disabled (on
|off
). -
availability-zone
- The Availability Zone of the host. -
client-token
- The idempotency token that you provided when you allocated the host. -
host-reservation-id
- The ID of the reservation assigned to this host. -
instance-type
- The instance type size that the Dedicated Host is configured to support. -
state
- The allocation state of the Dedicated Host (available
|under-assessment
|permanent-failure
|released
|released-permanent-failure
). -
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.
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 tofilter(List<Filter>)
.- Parameters:
filter
- 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:
-
-
hostIds
The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.
- Parameters:
hostIds
- The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hostIds
The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.
- Parameters:
hostIds
- The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned
nextToken
value. This value can be between 5 and 500. IfmaxResults
is given a larger value than 500, you receive an error.You cannot specify this parameter and the host IDs parameter in the same request.
- Parameters:
maxResults
- The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returnednextToken
value. This value can be between 5 and 500. IfmaxResults
is given a larger value than 500, you receive an error.You cannot specify this parameter and the host IDs parameter in the same request.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
The token to use to retrieve the next page of results.
- Parameters:
nextToken
- The token to use to retrieve the next page of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeHostsRequest.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
DescribeHostsRequest.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.
-