software.amazon.awssdk.services.ec2.model

Interface DescribeInstanceStatusRequest.Builder

All Superinterfaces:

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

Enclosing class:

DescribeInstanceStatusRequest

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

Method Summary

Modifier and Type	Method and Description
DescribeInstanceStatusRequest.Builder	filters(Collection<Filter> filters) The filters.
DescribeInstanceStatusRequest.Builder	filters(Consumer<Filter.Builder>... filters) The filters.
DescribeInstanceStatusRequest.Builder	filters(Filter... filters) The filters.
DescribeInstanceStatusRequest.Builder	includeAllInstances(Boolean includeAllInstances) When true, includes the health status for all instances.
DescribeInstanceStatusRequest.Builder	instanceIds(Collection<String> instanceIds) The instance IDs.
DescribeInstanceStatusRequest.Builder	instanceIds(String... instanceIds) The instance IDs.
DescribeInstanceStatusRequest.Builder	maxResults(Integer maxResults) The maximum number of items to return for this request.
DescribeInstanceStatusRequest.Builder	nextToken(String nextToken) The token returned from a previous paginated request.
DescribeInstanceStatusRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeInstanceStatusRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

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

equalsBySdkFields, 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

filters

DescribeInstanceStatusRequest.Builder filters(Collection<Filter> filters)

The filters.

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

• event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

• event.description - A description of the event.

• event.instance-event-id - The ID of the event whose date and time you are modifying.

• event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

• event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

• event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

• instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

• instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

• instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

• instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

• system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

• system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

Parameters:

filters - The filters.

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

• event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

• event.description - A description of the event.

• event.instance-event-id - The ID of the event whose date and time you are modifying.

• event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

• event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

• event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

• instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

• instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

• instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

• instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

• system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

• system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

Returns:

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

filters

DescribeInstanceStatusRequest.Builder filters(Filter... filters)

The filters.

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

• event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

• event.description - A description of the event.

• event.instance-event-id - The ID of the event whose date and time you are modifying.

• event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

• event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

• event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

• instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

• instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

• instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

• instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

• system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

• system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

Parameters:

filters - The filters.

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

• event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

• event.description - A description of the event.

• event.instance-event-id - The ID of the event whose date and time you are modifying.

• event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

• event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

• event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

• instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

• instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

• instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

• instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

• system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

• system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

Returns:

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

filters

DescribeInstanceStatusRequest.Builder filters(Consumer<Filter.Builder>... filters)

The filters.

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

• event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

• event.description - A description of the event.

• event.instance-event-id - The ID of the event whose date and time you are modifying.

• event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

• event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

• event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

• instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

• instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

• instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

• instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

• system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

• system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.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 on Filter.Builder

Returns:

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

See Also:

#filters(java.util.Collection)

instanceIds

DescribeInstanceStatusRequest.Builder instanceIds(Collection<String> instanceIds)

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Parameters:

instanceIds - The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Returns:

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

instanceIds

DescribeInstanceStatusRequest.Builder instanceIds(String... instanceIds)

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Parameters:

instanceIds - The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

Returns:

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

maxResults

DescribeInstanceStatusRequest.Builder maxResults(Integer maxResults)

The maximum number of items to return for this request. To retrieve the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call. For more information, see Pagination.

Parameters:

maxResults - The maximum number of items to return for this request. To retrieve the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call. For more information, see Pagination.

Returns:

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

nextToken

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

includeAllInstances

DescribeInstanceStatusRequest.Builder includeAllInstances(Boolean includeAllInstances)

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

Parameters:

includeAllInstances - When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

Returns:

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

overrideConfiguration

DescribeInstanceStatusRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeInstanceStatusRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder