com.amazonaws.services.ec2.model

Class DescribeClassicLinkInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeClassicLinkInstancesRequest

All Implemented Interfaces:

ReadLimitInfo, DryRunSupportedRequest<DescribeClassicLinkInstancesRequest>, Serializable, Cloneable

public class DescribeClassicLinkInstancesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeClassicLinkInstancesRequest>

Container for the parameters to the DescribeClassicLinkInstances operation.

Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances.

See Also:

AmazonEC2.describeClassicLinkInstances(DescribeClassicLinkInstancesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeClassicLinkInstancesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeClassicLinkInstancesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Request<DescribeClassicLinkInstancesRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() One or more filters.
List<String>	getInstanceIds() One or more instance IDs.
Integer	getMaxResults() The maximum number of results to return for the request in a single page.
String	getNextToken() The token to retrieve the next page of results.
int	hashCode()
void	setFilters(Collection<Filter> filters) One or more filters.
void	setInstanceIds(Collection<String> instanceIds) One or more instance IDs.
void	setMaxResults(Integer maxResults) The maximum number of results to return for the request in a single page.
void	setNextToken(String nextToken) The token to retrieve the next page of results.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeClassicLinkInstancesRequest	withFilters(Collection<Filter> filters) One or more filters.
DescribeClassicLinkInstancesRequest	withFilters(Filter... filters) One or more filters.
DescribeClassicLinkInstancesRequest	withInstanceIds(Collection<String> instanceIds) One or more instance IDs.
DescribeClassicLinkInstancesRequest	withInstanceIds(String... instanceIds) One or more instance IDs.
DescribeClassicLinkInstancesRequest	withMaxResults(Integer maxResults) The maximum number of results to return for the request in a single page.
DescribeClassicLinkInstancesRequest	withNextToken(String nextToken) The token to retrieve the next page of results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeClassicLinkInstancesRequest

public DescribeClassicLinkInstancesRequest()

Method Detail

getInstanceIds

public List<String> getInstanceIds()

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

Returns:

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

setInstanceIds

public void setInstanceIds(Collection<String> instanceIds)

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

Parameters:

instanceIds - One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

withInstanceIds

public DescribeClassicLinkInstancesRequest withInstanceIds(String... instanceIds)

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

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

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

Parameters:

instanceIds - One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

Returns:

A reference to this updated object so that method calls can be chained together.

withInstanceIds

public DescribeClassicLinkInstancesRequest withInstanceIds(Collection<String> instanceIds)

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

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

Parameters:

instanceIds - One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilters

public List<Filter> getFilters()

One or more filters.

• group-id - The ID of a VPC security group that's associated with the instance.

• instance-id - The ID of the instance.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• vpc-id - The ID of the VPC that the instance is linked to.

Returns:

One or more filters.

• group-id - The ID of a VPC security group that's associated with the instance.

• instance-id - The ID of the instance.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• vpc-id - The ID of the VPC that the instance is linked to.

setFilters

public void setFilters(Collection<Filter> filters)

One or more filters.

• group-id - The ID of a VPC security group that's associated with the instance.

• instance-id - The ID of the instance.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• vpc-id - The ID of the VPC that the instance is linked to.

Parameters:

filters - One or more filters.

• group-id - The ID of a VPC security group that's associated with the instance.

• instance-id - The ID of the instance.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• vpc-id - The ID of the VPC that the instance is linked to.

withFilters

public DescribeClassicLinkInstancesRequest withFilters(Filter... filters)

One or more filters.

• group-id - The ID of a VPC security group that's associated with the instance.

• instance-id - The ID of the instance.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• vpc-id - The ID of the VPC that the instance is linked to.

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

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

Parameters:

filters - One or more filters.

• group-id - The ID of a VPC security group that's associated with the instance.

• instance-id - The ID of the instance.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• vpc-id - The ID of the VPC that the instance is linked to.

Returns:

A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeClassicLinkInstancesRequest withFilters(Collection<Filter> filters)

One or more filters.

• group-id - The ID of a VPC security group that's associated with the instance.

• instance-id - The ID of the instance.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• vpc-id - The ID of the VPC that the instance is linked to.

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

Parameters:

filters - One or more filters.

• group-id - The ID of a VPC security group that's associated with the instance.

• instance-id - The ID of the instance.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• vpc-id - The ID of the VPC that the instance is linked to.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

The token to retrieve the next page of results.

Returns:

The token to retrieve the next page of results.

setNextToken

public void setNextToken(String nextToken)

The token to retrieve the next page of results.

Parameters:

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

withNextToken

public DescribeClassicLinkInstancesRequest withNextToken(String nextToken)

The token to retrieve the next page of results.

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

Returns:

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

Parameters:

maxResults - The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

withMaxResults

public DescribeClassicLinkInstancesRequest withMaxResults(Integer maxResults)

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

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

Parameters:

maxResults - The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

Returns:

A reference to this updated object so that method calls can be chained together.

getDryRunRequest

public Request<DescribeClassicLinkInstancesRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<DescribeClassicLinkInstancesRequest>

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeClassicLinkInstancesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()