/* * Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.ec2.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; import com.amazonaws.Request; import com.amazonaws.services.ec2.model.transform.DescribeInstanceStatusRequestMarshaller; /** * Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#describeInstanceStatus(DescribeInstanceStatusRequest) DescribeInstanceStatus operation}. *
* Describes the status of one or more instances. By default, only * running instances are described, unless specified otherwise. *
** Instance status includes the following components: *
* ** Status checks - Amazon EC2 performs status checks on running * EC2 instances to identify hardware and software issues. For more * information, see * Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks * in the Amazon Elastic Compute Cloud User Guide . *
** Scheduled events - Amazon EC2 can schedule events (such as * reboot, stop, or terminate) for your instances related to hardware * issues, software updates, or system maintenance. For more information, * see * Scheduled Events for Your Instances * in the Amazon Elastic Compute Cloud User Guide . *
** Instance state - You can manage your instances from the moment * you launch them through their termination. For more information, see * Instance Lifecycle * in the Amazon Elastic Compute Cloud User Guide . *
*Default: Describes all your instances. *
Constraints: Maximum 100 explicitly specified instance IDs.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag Default: Default: Describes all your instances.
* Constraints: Maximum 100 explicitly specified instance IDs.
*
* @return One or more instance IDs. Default: Describes all your instances.
* Constraints: Maximum 100 explicitly specified instance IDs.
*/
public java.util.List Default: Describes all your instances.
* Constraints: Maximum 100 explicitly specified instance IDs.
*
* @param instanceIds One or more instance IDs. Default: Describes all your instances.
* Constraints: Maximum 100 explicitly specified instance IDs.
*/
public void setInstanceIds(java.util.Collection Default: Describes all your instances.
* Constraints: Maximum 100 explicitly specified instance IDs.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param instanceIds One or more instance IDs. Default: Describes all your instances.
* Constraints: Maximum 100 explicitly specified instance IDs.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeInstanceStatusRequest withInstanceIds(String... instanceIds) {
if (getInstanceIds() == null) setInstanceIds(new java.util.ArrayList Default: Describes all your instances.
* Constraints: Maximum 100 explicitly specified instance IDs.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param instanceIds One or more instance IDs. Default: Describes all your instances.
* Constraints: Maximum 100 explicitly specified instance IDs.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeInstanceStatusRequest withInstanceIds(java.util.Collection
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters.
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters.
* Returns a reference to this object so that method calls can be chained together.
*
* @param nextToken The token to retrieve the next page of results.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeInstanceStatusRequest withNextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
/**
* The maximum number of results to return in a single call. To retrieve
* the remaining results, make another call with the returned
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param maxResults The maximum number of results to return in a single call. To retrieve
* the remaining results, make another call with the returned
* Default: Default: Default: Default: Default:
* Returns a reference to this object so that method calls can be chained together.
*
* @param includeAllInstances When Default: Default: Default:
*/
private com.amazonaws.internal.ListWithAutoConstructFlagavailability-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.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
). instance-state-code
- The code for the instance state,
* as a 16-bit unsigned integer. The high byte is an opaque internal
* value 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
). NextToken
value. This value can be between 5 and 1000.
* You cannot specify this parameter and the instance IDs parameter in
* the same call.
*/
private Integer maxResults;
/**
* When true
, includes the health status for all instances.
* When false
, includes the health status for running
* instances only. false
*/
private Boolean includeAllInstances;
/**
* One or more instance IDs.
*
* @return One or more 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.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
). instance-state-code
- The code for the instance state,
* as a 16-bit unsigned integer. The high byte is an opaque internal
* value 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
).
*/
public java.util.Listavailability-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.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
). instance-state-code
- The code for the instance state,
* as a 16-bit unsigned integer. The high byte is an opaque internal
* value 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
).
*
* @param filters One or more 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.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
). instance-state-code
- The code for the instance state,
* as a 16-bit unsigned integer. The high byte is an opaque internal
* value 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
).
*/
public void setFilters(java.util.Collectionavailability-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.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
). instance-state-code
- The code for the instance state,
* as a 16-bit unsigned integer. The high byte is an opaque internal
* value 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
).
* 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.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
). instance-state-code
- The code for the instance state,
* as a 16-bit unsigned integer. The high byte is an opaque internal
* value 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
).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeInstanceStatusRequest withFilters(Filter... filters) {
if (getFilters() == null) setFilters(new java.util.ArrayListavailability-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.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
). instance-state-code
- The code for the instance state,
* as a 16-bit unsigned integer. The high byte is an opaque internal
* value 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
).
* 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.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
). instance-state-code
- The code for the instance state,
* as a 16-bit unsigned integer. The high byte is an opaque internal
* value 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
).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeInstanceStatusRequest withFilters(java.util.Collectionavailability-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.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
). instance-state-code
- The code for the instance state,
* as a 16-bit unsigned integer. The high byte is an opaque internal
* value 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
). NextToken
value. This value can be between 5 and 1000.
* You cannot specify this parameter and the instance IDs parameter in
* the same call.
*
* @return The maximum number of results to return in a single call. To retrieve
* the remaining results, make another call with the returned
* NextToken
value. This value can be between 5 and 1000.
* You cannot specify this parameter and the instance IDs parameter in
* the same call.
*/
public Integer getMaxResults() {
return maxResults;
}
/**
* The maximum number of results to return in a single call. To retrieve
* the remaining results, make another call with the returned
* NextToken
value. This value can be between 5 and 1000.
* You cannot specify this parameter and the instance IDs parameter in
* the same call.
*
* @param maxResults The maximum number of results to return in a single call. To retrieve
* the remaining results, make another call with the returned
* NextToken
value. This value can be between 5 and 1000.
* You cannot specify this parameter and the instance IDs parameter in
* the same call.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
* The maximum number of results to return in a single call. To retrieve
* the remaining results, make another call with the returned
* NextToken
value. This value can be between 5 and 1000.
* You cannot specify this parameter and the instance IDs parameter in
* the same call.
* NextToken
value. This value can be between 5 and 1000.
* You cannot specify this parameter and the instance IDs parameter in
* the same call.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeInstanceStatusRequest withMaxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
/**
* When true
, includes the health status for all instances.
* When false
, includes the health status for running
* instances only. false
*
* @return When true
, includes the health status for all instances.
* When false
, includes the health status for running
* instances only. false
*/
public Boolean isIncludeAllInstances() {
return includeAllInstances;
}
/**
* When true
, includes the health status for all instances.
* When false
, includes the health status for running
* instances only. false
*
* @param includeAllInstances When true
, includes the health status for all instances.
* When false
, includes the health status for running
* instances only. false
*/
public void setIncludeAllInstances(Boolean includeAllInstances) {
this.includeAllInstances = includeAllInstances;
}
/**
* When true
, includes the health status for all instances.
* When false
, includes the health status for running
* instances only. false
* true
, includes the health status for all instances.
* When false
, includes the health status for running
* instances only. false
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeInstanceStatusRequest withIncludeAllInstances(Boolean includeAllInstances) {
this.includeAllInstances = includeAllInstances;
return this;
}
/**
* When true
, includes the health status for all instances.
* When false
, includes the health status for running
* instances only. false
*
* @return When true
, includes the health status for all instances.
* When false
, includes the health status for running
* instances only. false
*/
public Boolean getIncludeAllInstances() {
return includeAllInstances;
}
/**
* This method is intended for internal use only.
* Returns the marshaled request configured with additional parameters to
* enable operation dry-run.
*/
@Override
public Request