Package software.amazon.awssdk.services.ec2.model

Interface DescribeHostsRequest.Builder

All Superinterfaces:

CopyableBuilder<DescribeHostsRequest.Builder,DescribeHostsRequest>, SdkBuilder<DescribeHostsRequest.Builder,DescribeHostsRequest>

Enclosing class:

DescribeHostsRequest

public static interface DescribeHostsRequest.Builder
extends CopyableBuilder<DescribeHostsRequest.Builder,DescribeHostsRequest>

Method Summary

Modifier and Type	Method	Description
DescribeHostsRequest.Builder	filter(Collection<Filter> filter)	One or more filters.
DescribeHostsRequest.Builder	filter(Filter... filter)	One or more filters.
DescribeHostsRequest.Builder	hostIds(String... hostIds)	The IDs of the Dedicated Hosts.
DescribeHostsRequest.Builder	hostIds(Collection<String> hostIds)	The IDs of the Dedicated Hosts.
DescribeHostsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return for the request in a single page.
DescribeHostsRequest.Builder	nextToken(String nextToken)	The token to retrieve the next page of results.

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

copy

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

apply, build

Method Detail

filter

DescribeHostsRequest.Builder filter(Collection<Filter> filter)

One or more filters.

• instance-type - The instance type size that the Dedicated Host is configured to support.

• auto-placement - Whether auto-placement is enabled or disabled (on | off).

• host-reservation-id - The ID of the reservation assigned to this host.

• client-token - The idempotency token you provided when you launched the instance

• state- The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

• availability-zone - The Availability Zone of the host.

Parameters:

filter - One or more filters.

• instance-type - The instance type size that the Dedicated Host is configured to support.

• auto-placement - Whether auto-placement is enabled or disabled (on | off).

• host-reservation-id - The ID of the reservation assigned to this host.

• client-token - The idempotency token you provided when you launched the instance

• state- The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

• availability-zone - The Availability Zone of the host.

Returns:

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

filter

DescribeHostsRequest.Builder filter(Filter... filter)

One or more filters.

• instance-type - The instance type size that the Dedicated Host is configured to support.

• auto-placement - Whether auto-placement is enabled or disabled (on | off).

• host-reservation-id - The ID of the reservation assigned to this host.

• client-token - The idempotency token you provided when you launched the instance

• state- The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

• availability-zone - The Availability Zone of the host.

NOTE: This method appends the values to the existing list (if any). Use #setFilter(java.util.Collection) or #withFilter(java.util.Collection) if you want to override the existing values.

Parameters:

filter - One or more filters.

• instance-type - The instance type size that the Dedicated Host is configured to support.

• auto-placement - Whether auto-placement is enabled or disabled (on | off).

• host-reservation-id - The ID of the reservation assigned to this host.

• client-token - The idempotency token you provided when you launched the instance

• state- The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

• availability-zone - The Availability Zone of the host.

Returns:

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

hostIds

DescribeHostsRequest.Builder hostIds(Collection<String> 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

DescribeHostsRequest.Builder hostIds(String... hostIds)

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

NOTE: This method appends the values to the existing list (if any). Use #setHostIds(java.util.Collection) or #withHostIds(java.util.Collection) if you want to override the existing values.

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

DescribeHostsRequest.Builder maxResults(Integer 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; if maxResults is given a larger value than 500, you will 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 returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will 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

DescribeHostsRequest.Builder nextToken(String nextToken)

The token to retrieve the next page of results.

Parameters:

nextToken - The token to retrieve the next page of results.

Returns:

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