com.amazonaws.services.ec2.model

Class DescribeKeyPairsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeKeyPairsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<DescribeKeyPairsRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeKeyPairsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeKeyPairsRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeKeyPairsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeKeyPairsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Request<DescribeKeyPairsRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() The filters.
Boolean	getIncludePublicKey() If true, the public key material is included in the response.
List<String>	getKeyNames() The key pair names.
List<String>	getKeyPairIds() The IDs of the key pairs.
int	hashCode()
Boolean	isIncludePublicKey() If true, the public key material is included in the response.
void	setFilters(Collection<Filter> filters) The filters.
void	setIncludePublicKey(Boolean includePublicKey) If true, the public key material is included in the response.
void	setKeyNames(Collection<String> keyNames) The key pair names.
void	setKeyPairIds(Collection<String> keyPairIds) The IDs of the key pairs.
String	toString() Returns a string representation of this object.
DescribeKeyPairsRequest	withFilters(Collection<Filter> filters) The filters.
DescribeKeyPairsRequest	withFilters(Filter... filters) The filters.
DescribeKeyPairsRequest	withIncludePublicKey(Boolean includePublicKey) If true, the public key material is included in the response.
DescribeKeyPairsRequest	withKeyNames(Collection<String> keyNames) The key pair names.
DescribeKeyPairsRequest	withKeyNames(String... keyNames) The key pair names.
DescribeKeyPairsRequest	withKeyPairIds(Collection<String> keyPairIds) The IDs of the key pairs.
DescribeKeyPairsRequest	withKeyPairIds(String... keyPairIds) The IDs of the key pairs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeKeyPairsRequest

public DescribeKeyPairsRequest()

Method Detail

getFilters

public List<Filter> getFilters()

The filters.

• key-pair-id - The ID of the key pair.

• fingerprint - The fingerprint of the key pair.

• key-name - The name of the key pair.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

Returns:

The filters.

• key-pair-id - The ID of the key pair.

• fingerprint - The fingerprint of the key pair.

• key-name - The name of the key pair.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

setFilters

public void setFilters(Collection<Filter> filters)

The filters.

• key-pair-id - The ID of the key pair.

• fingerprint - The fingerprint of the key pair.

• key-name - The name of the key pair.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

Parameters:

filters - The filters.

• key-pair-id - The ID of the key pair.

• fingerprint - The fingerprint of the key pair.

• key-name - The name of the key pair.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

withFilters

public DescribeKeyPairsRequest withFilters(Filter... filters)

The filters.

• key-pair-id - The ID of the key pair.

• fingerprint - The fingerprint of the key pair.

• key-name - The name of the key pair.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

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.

Parameters:

filters - The filters.

• key-pair-id - The ID of the key pair.

• fingerprint - The fingerprint of the key pair.

• key-name - The name of the key pair.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

Returns:

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

withFilters

public DescribeKeyPairsRequest withFilters(Collection<Filter> filters)

The filters.

• key-pair-id - The ID of the key pair.

• fingerprint - The fingerprint of the key pair.

• key-name - The name of the key pair.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

Parameters:

filters - The filters.

• key-pair-id - The ID of the key pair.

• fingerprint - The fingerprint of the key pair.

• key-name - The name of the key pair.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

Returns:

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

getKeyNames

public List<String> getKeyNames()

The key pair names.

Default: Describes all of your key pairs.

Returns:

The key pair names.

Default: Describes all of your key pairs.

setKeyNames

public void setKeyNames(Collection<String> keyNames)

The key pair names.

Default: Describes all of your key pairs.

Parameters:

keyNames - The key pair names.

Default: Describes all of your key pairs.

withKeyNames

public DescribeKeyPairsRequest withKeyNames(String... keyNames)

The key pair names.

Default: Describes all of your key pairs.

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

Parameters:

keyNames - The key pair names.

Default: Describes all of your key pairs.

Returns:

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

withKeyNames

public DescribeKeyPairsRequest withKeyNames(Collection<String> keyNames)

The key pair names.

Default: Describes all of your key pairs.

Parameters:

keyNames - The key pair names.

Default: Describes all of your key pairs.

Returns:

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

getKeyPairIds

public List<String> getKeyPairIds()

The IDs of the key pairs.

Returns:

The IDs of the key pairs.

setKeyPairIds

public void setKeyPairIds(Collection<String> keyPairIds)

The IDs of the key pairs.

Parameters:

keyPairIds - The IDs of the key pairs.

withKeyPairIds

public DescribeKeyPairsRequest withKeyPairIds(String... keyPairIds)

The IDs of the key pairs.

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

Parameters:

keyPairIds - The IDs of the key pairs.

Returns:

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

withKeyPairIds

public DescribeKeyPairsRequest withKeyPairIds(Collection<String> keyPairIds)

The IDs of the key pairs.

Parameters:

keyPairIds - The IDs of the key pairs.

Returns:

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

setIncludePublicKey

public void setIncludePublicKey(Boolean includePublicKey)

If true, the public key material is included in the response.

Default: false

Parameters:

includePublicKey - If true, the public key material is included in the response.

Default: false

getIncludePublicKey

public Boolean getIncludePublicKey()

If true, the public key material is included in the response.

Default: false

Returns:

If true, the public key material is included in the response.

Default: false

withIncludePublicKey

public DescribeKeyPairsRequest withIncludePublicKey(Boolean includePublicKey)

If true, the public key material is included in the response.

Default: false

Parameters:

includePublicKey - If true, the public key material is included in the response.

Default: false

Returns:

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

isIncludePublicKey

public Boolean isIncludePublicKey()

If true, the public key material is included in the response.

Default: false

Returns:

If true, the public key material is included in the response.

Default: false

getDryRunRequest

public Request<DescribeKeyPairsRequest> 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<DescribeKeyPairsRequest>

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeKeyPairsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()