@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class InstanceAccessDetails extends Object implements Serializable, Cloneable, StructuredPojo
The parameters for gaining temporary access to one of your Amazon Lightsail instances.
Constructor and Description |
---|
InstanceAccessDetails() |
Modifier and Type | Method and Description |
---|---|
InstanceAccessDetails |
clone() |
boolean |
equals(Object obj) |
String |
getCertKey()
For SSH access, the public key to use when accessing your instance For OpenSSH clients (command line SSH), you
should save this value to
tempkey-cert.pub . |
Date |
getExpiresAt()
For SSH access, the date on which the temporary keys expire.
|
List<HostKeyAttributes> |
getHostKeys()
Describes the public SSH host keys or the RDP certificate.
|
String |
getInstanceName()
The name of this Amazon Lightsail instance.
|
String |
getIpAddress()
The public IP address of the Amazon Lightsail instance.
|
List<String> |
getIpv6Addresses()
The IPv6 address of the Amazon Lightsail instance.
|
String |
getPassword()
For RDP access, the password for your Amazon Lightsail instance.
|
PasswordData |
getPasswordData()
For a Windows Server-based instance, an object with the data you can use to retrieve your password.
|
String |
getPrivateKey()
For SSH access, the temporary private key.
|
String |
getProtocol()
The protocol for these Amazon Lightsail instance access details.
|
String |
getUsername()
The user name to use when logging in to the Amazon Lightsail instance.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCertKey(String certKey)
For SSH access, the public key to use when accessing your instance For OpenSSH clients (command line SSH), you
should save this value to
tempkey-cert.pub . |
void |
setExpiresAt(Date expiresAt)
For SSH access, the date on which the temporary keys expire.
|
void |
setHostKeys(Collection<HostKeyAttributes> hostKeys)
Describes the public SSH host keys or the RDP certificate.
|
void |
setInstanceName(String instanceName)
The name of this Amazon Lightsail instance.
|
void |
setIpAddress(String ipAddress)
The public IP address of the Amazon Lightsail instance.
|
void |
setIpv6Addresses(Collection<String> ipv6Addresses)
The IPv6 address of the Amazon Lightsail instance.
|
void |
setPassword(String password)
For RDP access, the password for your Amazon Lightsail instance.
|
void |
setPasswordData(PasswordData passwordData)
For a Windows Server-based instance, an object with the data you can use to retrieve your password.
|
void |
setPrivateKey(String privateKey)
For SSH access, the temporary private key.
|
void |
setProtocol(InstanceAccessProtocol protocol)
The protocol for these Amazon Lightsail instance access details.
|
void |
setProtocol(String protocol)
The protocol for these Amazon Lightsail instance access details.
|
void |
setUsername(String username)
The user name to use when logging in to the Amazon Lightsail instance.
|
String |
toString()
Returns a string representation of this object.
|
InstanceAccessDetails |
withCertKey(String certKey)
For SSH access, the public key to use when accessing your instance For OpenSSH clients (command line SSH), you
should save this value to
tempkey-cert.pub . |
InstanceAccessDetails |
withExpiresAt(Date expiresAt)
For SSH access, the date on which the temporary keys expire.
|
InstanceAccessDetails |
withHostKeys(Collection<HostKeyAttributes> hostKeys)
Describes the public SSH host keys or the RDP certificate.
|
InstanceAccessDetails |
withHostKeys(HostKeyAttributes... hostKeys)
Describes the public SSH host keys or the RDP certificate.
|
InstanceAccessDetails |
withInstanceName(String instanceName)
The name of this Amazon Lightsail instance.
|
InstanceAccessDetails |
withIpAddress(String ipAddress)
The public IP address of the Amazon Lightsail instance.
|
InstanceAccessDetails |
withIpv6Addresses(Collection<String> ipv6Addresses)
The IPv6 address of the Amazon Lightsail instance.
|
InstanceAccessDetails |
withIpv6Addresses(String... ipv6Addresses)
The IPv6 address of the Amazon Lightsail instance.
|
InstanceAccessDetails |
withPassword(String password)
For RDP access, the password for your Amazon Lightsail instance.
|
InstanceAccessDetails |
withPasswordData(PasswordData passwordData)
For a Windows Server-based instance, an object with the data you can use to retrieve your password.
|
InstanceAccessDetails |
withPrivateKey(String privateKey)
For SSH access, the temporary private key.
|
InstanceAccessDetails |
withProtocol(InstanceAccessProtocol protocol)
The protocol for these Amazon Lightsail instance access details.
|
InstanceAccessDetails |
withProtocol(String protocol)
The protocol for these Amazon Lightsail instance access details.
|
InstanceAccessDetails |
withUsername(String username)
The user name to use when logging in to the Amazon Lightsail instance.
|
public void setCertKey(String certKey)
For SSH access, the public key to use when accessing your instance For OpenSSH clients (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 (command line SSH),
you should save this value to tempkey-cert.pub
.public String getCertKey()
For SSH access, the public key to use when accessing your instance For OpenSSH clients (command line SSH), you
should save this value to tempkey-cert.pub
.
tempkey-cert.pub
.public InstanceAccessDetails withCertKey(String certKey)
For SSH access, the public key to use when accessing your instance For OpenSSH clients (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 (command line SSH),
you should save this value to tempkey-cert.pub
.public void setExpiresAt(Date expiresAt)
For SSH access, the date on which the temporary keys expire.
expiresAt
- For SSH access, the date on which the temporary keys expire.public Date getExpiresAt()
For SSH access, the date on which the temporary keys expire.
public InstanceAccessDetails withExpiresAt(Date expiresAt)
For SSH access, the date on which the temporary keys expire.
expiresAt
- For SSH access, the date on which the temporary keys expire.public void setIpAddress(String ipAddress)
The public IP address of the Amazon Lightsail instance.
ipAddress
- The public IP address of the Amazon Lightsail instance.public String getIpAddress()
The public IP address of the Amazon Lightsail instance.
public InstanceAccessDetails withIpAddress(String ipAddress)
The public IP address of the Amazon Lightsail instance.
ipAddress
- The public IP address of the Amazon Lightsail instance.public List<String> getIpv6Addresses()
The IPv6 address of the Amazon Lightsail instance.
public void setIpv6Addresses(Collection<String> ipv6Addresses)
The IPv6 address of the Amazon Lightsail instance.
ipv6Addresses
- The IPv6 address of the Amazon Lightsail instance.public InstanceAccessDetails withIpv6Addresses(String... ipv6Addresses)
The IPv6 address of the Amazon Lightsail instance.
NOTE: This method appends the values to the existing list (if any). Use
setIpv6Addresses(java.util.Collection)
or withIpv6Addresses(java.util.Collection)
if you want
to override the existing values.
ipv6Addresses
- The IPv6 address of the Amazon Lightsail instance.public InstanceAccessDetails withIpv6Addresses(Collection<String> ipv6Addresses)
The IPv6 address of the Amazon Lightsail instance.
ipv6Addresses
- The IPv6 address of the Amazon Lightsail instance.public void setPassword(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.
public String getPassword()
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.
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.
public InstanceAccessDetails withPassword(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.
public void setPasswordData(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.public PasswordData getPasswordData()
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.
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.public InstanceAccessDetails withPasswordData(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.public void setPrivateKey(String privateKey)
For SSH access, the temporary private key. For OpenSSH clients (command line SSH), you should save this value to
tempkey
).
privateKey
- For SSH access, the temporary private key. For OpenSSH clients (command line SSH), you should save this
value to tempkey
).public String getPrivateKey()
For SSH access, the temporary private key. For OpenSSH clients (command line SSH), you should save this value to
tempkey
).
tempkey
).public InstanceAccessDetails withPrivateKey(String privateKey)
For SSH access, the temporary private key. For OpenSSH clients (command line SSH), you should save this value to
tempkey
).
privateKey
- For SSH access, the temporary private key. For OpenSSH clients (command line SSH), you should save this
value to tempkey
).public void setProtocol(String protocol)
The protocol for these Amazon Lightsail instance access details.
protocol
- The protocol for these Amazon Lightsail instance access details.InstanceAccessProtocol
public String getProtocol()
The protocol for these Amazon Lightsail instance access details.
InstanceAccessProtocol
public InstanceAccessDetails withProtocol(String protocol)
The protocol for these Amazon Lightsail instance access details.
protocol
- The protocol for these Amazon Lightsail instance access details.InstanceAccessProtocol
public void setProtocol(InstanceAccessProtocol protocol)
The protocol for these Amazon Lightsail instance access details.
protocol
- The protocol for these Amazon Lightsail instance access details.InstanceAccessProtocol
public InstanceAccessDetails withProtocol(InstanceAccessProtocol protocol)
The protocol for these Amazon Lightsail instance access details.
protocol
- The protocol for these Amazon Lightsail instance access details.InstanceAccessProtocol
public void setInstanceName(String instanceName)
The name of this Amazon Lightsail instance.
instanceName
- The name of this Amazon Lightsail instance.public String getInstanceName()
The name of this Amazon Lightsail instance.
public InstanceAccessDetails withInstanceName(String instanceName)
The name of this Amazon Lightsail instance.
instanceName
- The name of this Amazon Lightsail instance.public void setUsername(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.public String getUsername()
The user name to use when logging in to the Amazon Lightsail instance.
public InstanceAccessDetails withUsername(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.public List<HostKeyAttributes> getHostKeys()
Describes the public SSH host keys or the RDP certificate.
public void setHostKeys(Collection<HostKeyAttributes> hostKeys)
Describes the public SSH host keys or the RDP certificate.
hostKeys
- Describes the public SSH host keys or the RDP certificate.public InstanceAccessDetails withHostKeys(HostKeyAttributes... hostKeys)
Describes the public SSH host keys or the RDP certificate.
NOTE: This method appends the values to the existing list (if any). Use
setHostKeys(java.util.Collection)
or withHostKeys(java.util.Collection)
if you want to override
the existing values.
hostKeys
- Describes the public SSH host keys or the RDP certificate.public InstanceAccessDetails withHostKeys(Collection<HostKeyAttributes> hostKeys)
Describes the public SSH host keys or the RDP certificate.
hostKeys
- Describes the public SSH host keys or the RDP certificate.public String toString()
toString
in class Object
Object.toString()
public InstanceAccessDetails clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.