software.amazon.awssdk.services.ec2.model

Interface DescribeHostsRequest.Builder

All Superinterfaces:

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

Enclosing class:

DescribeHostsRequest

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

Method Summary

Modifier and Type	Method and Description
DescribeHostsRequest.Builder	filter(Collection<Filter> filter) One or more filters.
DescribeHostsRequest.Builder	filter(Consumer<Filter.Builder>... filter) One or more filters.
DescribeHostsRequest.Builder	filter(Filter... filter) One or more filters.
DescribeHostsRequest.Builder	hostIds(Collection<String> hostIds) The IDs of the Dedicated Hosts.
DescribeHostsRequest.Builder	hostIds(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.
DescribeHostsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
DescribeHostsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

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

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

filter

DescribeHostsRequest.Builder filter(Collection<Filter> filter)

One or more 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 - One or more 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

DescribeHostsRequest.Builder filter(Filter... filter)

One or more 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 - One or more 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

DescribeHostsRequest.Builder filter(Consumer<Filter.Builder>... filter)

One or more 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.

This is a convenience 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 #filter(List).

Parameters:

filter - 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:

#filter(List)

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.

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 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 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.

overrideConfiguration

DescribeHostsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.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 interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.