com.amazonaws.services.ec2.model

Class GetPasswordDataRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.GetPasswordDataRequest

All Implemented Interfaces:

ReadLimitInfo, DryRunSupportedRequest<GetPasswordDataRequest>, Serializable, Cloneable

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

Container for the parameters to the GetPasswordData operation.

Retrieves the encrypted administrator password for an instance running Windows.

The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword , is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

See Also:

AmazonEC2.getPasswordData(GetPasswordDataRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetPasswordDataRequest() Default constructor for a new GetPasswordDataRequest object.
GetPasswordDataRequest(String instanceId) Constructs a new GetPasswordDataRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
GetPasswordDataRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Request<GetPasswordDataRequest>	getDryRunRequest() This method is intended for internal use only.
String	getInstanceId() The ID of the Windows instance.
int	hashCode()
void	setInstanceId(String instanceId) The ID of the Windows instance.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetPasswordDataRequest	withInstanceId(String instanceId) The ID of the Windows instance.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

GetPasswordDataRequest

public GetPasswordDataRequest()

Default constructor for a new GetPasswordDataRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

GetPasswordDataRequest

public GetPasswordDataRequest(String instanceId)

Constructs a new GetPasswordDataRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

instanceId - The ID of the Windows instance.

Method Detail

getInstanceId

public String getInstanceId()

The ID of the Windows instance.

Returns:

The ID of the Windows instance.

setInstanceId

public void setInstanceId(String instanceId)

The ID of the Windows instance.

Parameters:

instanceId - The ID of the Windows instance.

withInstanceId

public GetPasswordDataRequest withInstanceId(String instanceId)

The ID of the Windows instance.

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

Parameters:

instanceId - The ID of the Windows instance.

Returns:

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

getDryRunRequest

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

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 GetPasswordDataRequest 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()