| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Lightsail::InstanceAccessDetails; | ||
| 3 | use Moose; | ||
| 4 | has CertKey => (is => 'ro', isa => 'Str', request_name => 'certKey', traits => ['NameInRequest']); | ||
| 5 | has ExpiresAt => (is => 'ro', isa => 'Str', request_name => 'expiresAt', traits => ['NameInRequest']); | ||
| 6 | has HostKeys => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::HostKeyAttributes]', request_name => 'hostKeys', traits => ['NameInRequest']); | ||
| 7 | has InstanceName => (is => 'ro', isa => 'Str', request_name => 'instanceName', traits => ['NameInRequest']); | ||
| 8 | has IpAddress => (is => 'ro', isa => 'Str', request_name => 'ipAddress', traits => ['NameInRequest']); | ||
| 9 | has Password => (is => 'ro', isa => 'Str', request_name => 'password', traits => ['NameInRequest']); | ||
| 10 | has PasswordData => (is => 'ro', isa => 'Paws::Lightsail::PasswordData', request_name => 'passwordData', traits => ['NameInRequest']); | ||
| 11 | has PrivateKey => (is => 'ro', isa => 'Str', request_name => 'privateKey', traits => ['NameInRequest']); | ||
| 12 | has Protocol => (is => 'ro', isa => 'Str', request_name => 'protocol', traits => ['NameInRequest']); | ||
| 13 | has Username => (is => 'ro', isa => 'Str', request_name => 'username', traits => ['NameInRequest']); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Lightsail::InstanceAccessDetails | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::Lightsail::InstanceAccessDetails object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { CertKey => $value, ..., Username => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::InstanceAccessDetails object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->CertKey | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | The parameters for gaining temporary access to one of your Amazon | ||
| 46 | Lightsail instances. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 CertKey => Str | ||
| 52 | |||
| 53 | For SSH access, the public key to use when accessing your instance For | ||
| 54 | OpenSSH clients (e.g., command line SSH), you should save this value to | ||
| 55 | C<tempkey-cert.pub>. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 ExpiresAt => Str | ||
| 59 | |||
| 60 | For SSH access, the date on which the temporary keys expire. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 HostKeys => ArrayRef[L<Paws::Lightsail::HostKeyAttributes>] | ||
| 64 | |||
| 65 | Describes the public SSH host keys or the RDP certificate. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 InstanceName => Str | ||
| 69 | |||
| 70 | The name of this Amazon Lightsail instance. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 IpAddress => Str | ||
| 74 | |||
| 75 | The public IP address of the Amazon Lightsail instance. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 Password => Str | ||
| 79 | |||
| 80 | For RDP access, the password for your Amazon Lightsail instance. | ||
| 81 | Password will be an empty string if the password for your new instance | ||
| 82 | is not ready yet. When you create an instance, it can take up to 15 | ||
| 83 | minutes for the instance to be ready. | ||
| 84 | |||
| 85 | If you create an instance using any key pair other than the default | ||
| 86 | (C<LightsailDefaultKeyPair>), C<password> will always be an empty | ||
| 87 | string. | ||
| 88 | |||
| 89 | If you change the Administrator password on the instance, Lightsail | ||
| 90 | will continue to return the original password value. When accessing the | ||
| 91 | instance using RDP, you need to manually enter the Administrator | ||
| 92 | password after changing it from the default. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 PasswordData => L<Paws::Lightsail::PasswordData> | ||
| 96 | |||
| 97 | For a Windows Server-based instance, an object with the data you can | ||
| 98 | use to retrieve your password. This is only needed if C<password> is | ||
| 99 | empty and the instance is not new (and therefore the password is not | ||
| 100 | ready yet). When you create an instance, it can take up to 15 minutes | ||
| 101 | for the instance to be ready. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 PrivateKey => Str | ||
| 105 | |||
| 106 | For SSH access, the temporary private key. For OpenSSH clients (e.g., | ||
| 107 | command line SSH), you should save this value to C<tempkey>). | ||
| 108 | |||
| 109 | |||
| 110 | =head2 Protocol => Str | ||
| 111 | |||
| 112 | The protocol for these Amazon Lightsail instance access details. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 Username => Str | ||
| 116 | |||
| 117 | The user name to use when logging in to the Amazon Lightsail instance. | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head1 SEE ALSO | ||
| 122 | |||
| 123 | This class forms part of L<Paws>, describing an object used in L<Paws::Lightsail> | ||
| 124 | |||
| 125 | =head1 BUGS and CONTRIBUTIONS | ||
| 126 | |||
| 127 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 128 | |||
| 129 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 130 | |||
| 131 | =cut | ||
| 132 |