Struct aws_sdk_lightsail::types::InstanceAccessDetails

#[non_exhaustive]
pub struct InstanceAccessDetails {
    pub cert_key: Option<String>,
    pub expires_at: Option<DateTime>,
    pub ip_address: Option<String>,
    pub ipv6_addresses: Option<Vec<String>>,
    pub password: Option<String>,
    pub password_data: Option<PasswordData>,
    pub private_key: Option<String>,
    pub protocol: Option<InstanceAccessProtocol>,
    pub instance_name: Option<String>,
    pub username: Option<String>,
    pub host_keys: Option<Vec<HostKeyAttributes>>,
}

The parameters for gaining temporary access to one of your Amazon Lightsail instances.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

cert_key: Option<String>

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.

expires_at: Option<DateTime>

For SSH access, the date on which the temporary keys expire.

ip_address: Option<String>

The public IP address of the Amazon Lightsail instance.

ipv6_addresses: Option<Vec<String>>

The IPv6 address of the Amazon Lightsail instance.

password: Option<String>

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_data: Option<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.

private_key: Option<String>

For SSH access, the temporary private key. For OpenSSH clients (command line SSH), you should save this value to tempkey).

protocol: Option<InstanceAccessProtocol>

The protocol for these Amazon Lightsail instance access details.

instance_name: Option<String>

The name of this Amazon Lightsail instance.

username: Option<String>

The user name to use when logging in to the Amazon Lightsail instance.

host_keys: Option<Vec<HostKeyAttributes>>

Describes the public SSH host keys or the RDP certificate.

Implementations

impl InstanceAccessDetails

pub fn cert_key(&self) -> Option<&str>

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.

pub fn expires_at(&self) -> Option<&DateTime>

For SSH access, the date on which the temporary keys expire.

pub fn ip_address(&self) -> Option<&str>

The public IP address of the Amazon Lightsail instance.

pub fn ipv6_addresses(&self) -> &[String]

The IPv6 address of the Amazon Lightsail instance.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .ipv6_addresses.is_none().

pub fn password(&self) -> Option<&str>

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.

pub fn password_data(&self) -> Option<&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.

pub fn private_key(&self) -> Option<&str>

For SSH access, the temporary private key. For OpenSSH clients (command line SSH), you should save this value to tempkey).

pub fn protocol(&self) -> Option<&InstanceAccessProtocol>

The protocol for these Amazon Lightsail instance access details.

pub fn instance_name(&self) -> Option<&str>

The name of this Amazon Lightsail instance.

pub fn username(&self) -> Option<&str>

The user name to use when logging in to the Amazon Lightsail instance.

pub fn host_keys(&self) -> &[HostKeyAttributes]

Describes the public SSH host keys or the RDP certificate.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .host_keys.is_none().

impl InstanceAccessDetails

pub fn builder() -> InstanceAccessDetailsBuilder

Creates a new builder-style object to manufacture InstanceAccessDetails.

Trait Implementations

impl Clone for InstanceAccessDetails

fn clone(&self) -> InstanceAccessDetails

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InstanceAccessDetails

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for InstanceAccessDetails

fn eq(&self, other: &InstanceAccessDetails) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for InstanceAccessDetails