Container for the parameters to the GetPasswordData operation. Retrieves the encrypted administrator password for a running Windows instance.
The Windows password is generated at boot by the EC2Config service or EC2Launch
scripts (Windows Server 2016 and later). This usually only happens the first time
an instance is launched. For more information, see EC2Config
and EC2Launch
in the Amazon EC2 User Guide.
For the EC2Config service, 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.
When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it's available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.EC2.AmazonEC2Request
Amazon.EC2.Model.GetPasswordDataRequest
Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z
Syntax
public class GetPasswordDataRequest : AmazonEC2Request IAmazonWebServiceRequest
The GetPasswordDataRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
GetPasswordDataRequest() |
Empty constructor used to set properties independently even when a simple constructor is available |
|
|
GetPasswordDataRequest(string) |
Instantiates GetPasswordDataRequest with the parameterized properties |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
InstanceId | System.String |
Gets and sets the property InstanceId. The ID of the Windows instance. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5