| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Lightsail::PasswordData; | ||
| 3 | use Moose; | ||
| 4 | has Ciphertext => (is => 'ro', isa => 'Str', request_name => 'ciphertext', traits => ['NameInRequest']); | ||
| 5 | has KeyPairName => (is => 'ro', isa => 'Str', request_name => 'keyPairName', traits => ['NameInRequest']); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Lightsail::PasswordData | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::Lightsail::PasswordData object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Ciphertext => $value, ..., KeyPairName => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::PasswordData object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Ciphertext | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | The password data for the Windows Server-based instance, including the | ||
| 38 | ciphertext and the key pair name. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 Ciphertext => Str | ||
| 44 | |||
| 45 | The encrypted password. Ciphertext will be an empty string if access to | ||
| 46 | your new instance is not ready yet. When you create an instance, it can | ||
| 47 | take up to 15 minutes for the instance to be ready. | ||
| 48 | |||
| 49 | If you use the default key pair (C<LightsailDefaultKeyPair>), the | ||
| 50 | decrypted password will be available in the password field. | ||
| 51 | |||
| 52 | If you are using a custom key pair, you need to use your own means of | ||
| 53 | decryption. | ||
| 54 | |||
| 55 | If you change the Administrator password on the instance, Lightsail | ||
| 56 | will continue to return the original ciphertext value. When accessing | ||
| 57 | the instance using RDP, you need to manually enter the Administrator | ||
| 58 | password after changing it from the default. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 KeyPairName => Str | ||
| 62 | |||
| 63 | The name of the key pair that you used when creating your instance. If | ||
| 64 | no key pair name was specified when creating the instance, Lightsail | ||
| 65 | uses the default key pair (C<LightsailDefaultKeyPair>). | ||
| 66 | |||
| 67 | If you are using a custom key pair, you need to use your own means of | ||
| 68 | decrypting your password using the C<ciphertext>. Lightsail creates the | ||
| 69 | ciphertext by encrypting your password with the public key part of this | ||
| 70 | key pair. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head1 SEE ALSO | ||
| 75 | |||
| 76 | This class forms part of L<Paws>, describing an object used in L<Paws::Lightsail> | ||
| 77 | |||
| 78 | =head1 BUGS and CONTRIBUTIONS | ||
| 79 | |||
| 80 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 81 | |||
| 82 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 83 | |||
| 84 | =cut | ||
| 85 |