public static interface InstanceAccessDetails.Builder extends CopyableBuilder<InstanceAccessDetails.Builder,InstanceAccessDetails>
Modifier and Type | Method and Description |
---|---|
InstanceAccessDetails.Builder |
certKey(String certKey)
For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line
SSH), you should save this value to
tempkey-cert.pub . |
InstanceAccessDetails.Builder |
expiresAt(Instant expiresAt)
For SSH access, the date on which the temporary keys expire.
|
InstanceAccessDetails.Builder |
instanceName(String instanceName)
The name of this Amazon Lightsail instance.
|
InstanceAccessDetails.Builder |
ipAddress(String ipAddress)
The public IP address of the Amazon Lightsail instance.
|
InstanceAccessDetails.Builder |
password(String password)
For RDP access, the password for your Amazon Lightsail instance.
|
default InstanceAccessDetails.Builder |
passwordData(Consumer<PasswordData.Builder> passwordData)
For a Windows Server-based instance, an object with the data you can use to retrieve your password.
|
InstanceAccessDetails.Builder |
passwordData(PasswordData passwordData)
For a Windows Server-based instance, an object with the data you can use to retrieve your password.
|
InstanceAccessDetails.Builder |
privateKey(String privateKey)
For SSH access, the temporary private key.
|
InstanceAccessDetails.Builder |
protocol(InstanceAccessProtocol protocol)
The protocol for these Amazon Lightsail instance access details.
|
InstanceAccessDetails.Builder |
protocol(String protocol)
The protocol for these Amazon Lightsail instance access details.
|
InstanceAccessDetails.Builder |
username(String username)
The user name to use when logging in to the Amazon Lightsail instance.
|
copy
apply, build
InstanceAccessDetails.Builder certKey(String certKey)
For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line
SSH), you should save this value to tempkey-cert.pub
.
certKey
- For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command
line SSH), you should save this value to tempkey-cert.pub
.InstanceAccessDetails.Builder expiresAt(Instant expiresAt)
For SSH access, the date on which the temporary keys expire.
expiresAt
- For SSH access, the date on which the temporary keys expire.InstanceAccessDetails.Builder ipAddress(String ipAddress)
The public IP address of the Amazon Lightsail instance.
ipAddress
- The public IP address of the Amazon Lightsail instance.InstanceAccessDetails.Builder password(String password)
For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if the password for your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.
If you create an instance using any key pair other than the default (LightsailDefaultKeyPair
),
password
will always be an empty string.
If you change the Administrator password on the instance, Lightsail will continue to return the original password value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.
password
- For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if
the password for your new instance is not ready yet. When you create an instance, it can take up to 15
minutes for the instance to be ready.
If you create an instance using any key pair other than the default (
LightsailDefaultKeyPair
), password
will always be an empty string.
If you change the Administrator password on the instance, Lightsail will continue to return the original password value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.
InstanceAccessDetails.Builder passwordData(PasswordData passwordData)
For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is
only needed if password
is empty and the instance is not new (and therefore the password is not
ready yet). When you create an instance, it can take up to 15 minutes for the instance to be ready.
passwordData
- For a Windows Server-based instance, an object with the data you can use to retrieve your password.
This is only needed if password
is empty and the instance is not new (and therefore the
password is not ready yet). When you create an instance, it can take up to 15 minutes for the instance
to be ready.default InstanceAccessDetails.Builder passwordData(Consumer<PasswordData.Builder> passwordData)
For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is
only needed if password
is empty and the instance is not new (and therefore the password is not
ready yet). When you create an instance, it can take up to 15 minutes for the instance to be ready.
PasswordData.Builder
avoiding the need to
create one manually via PasswordData.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to passwordData(PasswordData)
.passwordData
- a consumer that will call methods on PasswordData.Builder
passwordData(PasswordData)
InstanceAccessDetails.Builder privateKey(String privateKey)
For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this
value to tempkey
).
privateKey
- For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should
save this value to tempkey
).InstanceAccessDetails.Builder protocol(String protocol)
The protocol for these Amazon Lightsail instance access details.
protocol
- The protocol for these Amazon Lightsail instance access details.InstanceAccessProtocol
,
InstanceAccessProtocol
InstanceAccessDetails.Builder protocol(InstanceAccessProtocol protocol)
The protocol for these Amazon Lightsail instance access details.
protocol
- The protocol for these Amazon Lightsail instance access details.InstanceAccessProtocol
,
InstanceAccessProtocol
InstanceAccessDetails.Builder instanceName(String instanceName)
The name of this Amazon Lightsail instance.
instanceName
- The name of this Amazon Lightsail instance.InstanceAccessDetails.Builder username(String username)
The user name to use when logging in to the Amazon Lightsail instance.
username
- The user name to use when logging in to the Amazon Lightsail instance.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.